BobStore/HACKING.md

36 lines
879 B
Markdown
Raw Normal View History

2015-04-02 09:57:47 +02:00
F-Droid Client Hacking Doc
==========================
Style
-----
2015-04-06 11:09:40 +02:00
We loosely follow the [Google Java style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html).
Some of the points we follow the most are:
2015-04-02 09:57:47 +02:00
* Four space indentation
* UTF-8 source files
* Exactly one top-level class per file
* No wildcard imports
2015-04-06 11:09:40 +02:00
* One statement per line
* K&R spacings with braces and parenthesis
Some other interesting additions we might use in the future:
2015-04-02 09:57:47 +02:00
* Commented fallthroughs
2015-04-06 11:09:40 +02:00
* Braces are always used after if, for and while
2015-04-02 09:57:47 +02:00
2015-04-06 11:09:40 +02:00
We don't strictly follow the entire style spec, but when in doubt you should
follow it.
2015-04-02 09:57:47 +02:00
Building
--------
You have three options:
* Build with gradle
* Build with gradle from source
* Build with ant from source
Any will work, but if you use gradle, remember that you can use --daemon to
not have to watch gradle load every time.