Skip to content

Commit 38b29bd

Browse files
committed
Updated README, added CONTRIBUTING page.
Change on 2014/02/05 by tball <[email protected]> ------------- Created by MOE: http://code.google.com/p/moe-java MOE_MIGRATED_REVID=61072846
1 parent e0aca15 commit 38b29bd

File tree

3 files changed

+93
-26
lines changed

3 files changed

+93
-26
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# How to contribute #
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
a just a few small guidelines you need to follow.
5+
6+
7+
## Contributor License Agreement ##
8+
9+
Contributions to any Google project must be accompanied by a Contributor
10+
License Agreement. This is not a copyright **assignment**, it simply gives
11+
Google permission to use and redistribute your contributions as part of the
12+
project.
13+
14+
* If you are an individual writing original source code and you're sure you
15+
own the intellectual property, then you'll need to sign an [individual
16+
CLA][].
17+
18+
* If you work for a company that wants to allow you to contribute your work,
19+
then you'll need to sign a [corporate CLA][].
20+
21+
You generally only need to submit a CLA once, so if you've already submitted
22+
one (even if it was for a different project), you probably don't need to do it
23+
again.
24+
25+
[individual CLA]: https://developers.google.com/open-source/cla/individual
26+
[corporate CLA]: https://developers.google.com/open-source/cla/corporate
27+
28+
29+
## Submitting a patch ##
30+
31+
1. It's generally best to start by opening a new issue describing the bug or
32+
feature you're intending to fix. Even if you think it's relatively minor,
33+
it's helpful to know what people are working on. Mention in the initial
34+
issue that you are planning to work on that bug or feature so that it can
35+
be assigned to you.
36+
37+
1. Follow the normal process of [forking][] the project, and setup a new
38+
branch to work in. It's important that each group of changes be done in
39+
separate branches in order to ensure that a pull request only includes the
40+
commits related to that bug or feature.
41+
42+
1. Any significant changes should almost always be accompanied by tests. The
43+
project already has good test coverage, so look at some of the existing
44+
tests if you're unsure how to go about it.
45+
46+
1. Do your best to have [well-formed commit messages][] for each change.
47+
This provides consistency throughout the project, and ensures that commit
48+
messages are able to be formatted properly by various git tools.
49+
50+
1. Finally, push the commits to your fork and submit a [pull request][].
51+
52+
[forking]: https://help.github.com/articles/fork-a-repo
53+
[well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
54+
[pull request]: https://help.github.com/articles/creating-a-pull-request

README

Lines changed: 0 additions & 26 deletions
This file was deleted.

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# J2ObjC: Java to Objective-C Translator and Runtime #
2+
3+
**Project site:** <http://j2objc.org>
4+
**J2ObjC blog:** <http://j2objc.blogspot.com>
5+
**Questions and discussion:** <http://groups.google.com/group/j2objc-discuss>
6+
7+
### What J2ObjC Is ###
8+
J2ObjC is an open-source command-line tool from Google that translates
9+
Java code to Objective-C for the iOS (iPhone/iPad) platform. This tool
10+
enables Java code to be part of an iOS application's build, as no editing
11+
of the generated files is necessary. The goal is to write an app's non-UI
12+
code (such as data access, or application logic) in Java, which is then
13+
shared by web apps (using GWT), Android apps, and iOS apps.
14+
15+
J2ObjC supports most Java language and runtime features required by
16+
client-side application developers, including exceptions, inner and
17+
anonymous classes, generic types, threads and reflection. JUnit test
18+
translation and execution is also supported.
19+
20+
J2ObjC is currently between alpha and beta quality. Several Google projects
21+
rely on it, but when new projects first start working with it, they usually
22+
find new bugs to be fixed.
23+
24+
### What J2ObjC isn't ###
25+
J2ObjC does not provide any sort of platform-independent UI toolkit, nor are
26+
there any plans to do so in the future. We believe that iOS UI code needs to
27+
be written in Objective-C or Objective-C++ using Apple's iOS SDK (Android UIs
28+
using Android's API, web app UIs using GWT, etc.).
29+
30+
## Requirements ##
31+
32+
* JDK 1.6 or higher
33+
* Xcode 4 or higher
34+
* Mac OS X 10.7 or higher
35+
36+
## License ##
37+
38+
This library is distributed under the Apache 2.0 license found in the
39+
[LICENSE](./LICENSE) file.

0 commit comments

Comments
 (0)