README: Convert legacy asciidoc headers to markdown Change-Id: I3b12ee06c0aad029bae714fcd8d5f08010dcb71e
diff --git a/README.md b/README.md index 686f964..eab9489 100644 --- a/README.md +++ b/README.md
@@ -1,13 +1,10 @@ -Gitiles - A simple JGit repository browser -========================================== +# Gitiles - A simple JGit repository browser Gitiles is a simple repository browser for Git repositories, built on JGit. Its guiding principle is simplicity: it has no formal access controls, no write access, no fancy Javascript, etc. - -Building --------- +## Building Gitiles requires [Buck](http://facebook.github.io/buck/) to build. @@ -25,8 +22,7 @@ ``` -Testing -------- +## Testing ``` cd /path/to/repositories # Don't run from the gitiles repo. @@ -40,8 +36,7 @@ To run unit tests, run `buck test`. -Eclipse IDE ------------ +## Eclipse IDE If you'd like to use Eclipse to edit Gitiles, first generate a project file: @@ -60,8 +55,7 @@ Eclipse before rebuilding. -Code Style ----------- +## Code Style Java code in Gitiles follows the [Google Java Style Guide][java-style] with a 100-column limit. @@ -80,8 +74,7 @@ [fmt]: https://github.com/google/google-java-format [suit]: https://github.com/suitcss/suit/blob/master/doc/naming-conventions.md -Code Review ------------ +## Code Review Gitiles uses Gerrit for code review: https://gerrit-review.googlesource.com/