summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEvan Shelhamer <shelhamer@imaginarynumber.net>2014-02-28 19:41:24 (GMT)
committerEvan Shelhamer <shelhamer@imaginarynumber.net>2014-02-28 19:41:27 (GMT)
commitca4a6c1afae515fa891eddf3bc394b7fec46051f (patch)
treee0e2b3906ba3cb4440f5d146477a6ae5a38b0c3b /README.md
parent0a20e498651ba1aa5e4ba3a742f39637ef9451be (diff)
downloadcaffe-ca4a6c1afae515fa891eddf3bc394b7fec46051f.zip
caffe-ca4a6c1afae515fa891eddf3bc394b7fec46051f.tar.gz
caffe-ca4a6c1afae515fa891eddf3bc394b7fec46051f.tar.bz2
minor readme polish
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 59762ca..4b5153b 100644
--- a/README.md
+++ b/README.md
@@ -48,11 +48,11 @@ Please kindly cite Caffe in your publications if it helps your research:
Howpublished = {\url{http://caffe.berkeleyvision.org/}
}
-## Building documentation
+## Documentation
-Tutorials and general documentation is written in Markdown format in the `docs/` folder.
+Tutorials and general documentation are written in Markdown format in the `docs/` folder.
While the format is quite easy to read directly, you may prefer to view the whole thing as a website.
-To do so, simply run `jekyll serve -s docs` and view the documentation website at `http://0.0.0.0:4000` (to get jekyll, you must have ruby and do `gem install jekyll`).
+To do so, simply run `jekyll serve -s docs` and view the documentation website at `http://0.0.0.0:4000` (to get [jekyll](http://jekyllrb.com/), you must have ruby and do `gem install jekyll`).
We strive to provide provide lots of usage examples, and to document all code in docstrings.
We'd appreciate your contribution to this effort!
@@ -74,7 +74,7 @@ Our workflow is this:
* Code must be accompanied by documentation and tests at all times.
* Only fast-forward merges will be accepted.
-#### [Shelhamer's](https://github.com/shelhamer) "life of a branch in four acts":
+#### [Shelhamer's](https://github.com/shelhamer) “life of a branch in four acts”
Make the `feature` branch off of the latest `bvlc/dev`
```