summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSergey Karayev <sergeykarayev@gmail.com>2014-02-25 19:34:23 (GMT)
committerSergey Karayev <sergeykarayev@gmail.com>2014-02-25 19:34:23 (GMT)
commit27a83156847530ec20ef5dcff92773eee53258b7 (patch)
tree894c968de5510f16c98eda9b57cf7360f3fb1fdd /README.md
parentaea53c78d4819d975cca632b2401d932660a653a (diff)
downloadcaffe-27a83156847530ec20ef5dcff92773eee53258b7.zip
caffe-27a83156847530ec20ef5dcff92773eee53258b7.tar.gz
caffe-27a83156847530ec20ef5dcff92773eee53258b7.tar.bz2
Updated README with doc info
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 19 insertions, 17 deletions
diff --git a/README.md b/README.md
index 08a9fb8..bc1ec23 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
[Caffe: Convolutional Architecture for Fast Feature Extraction](http://caffe.berkeleyvision.org)
-Created by Yangqing Jia, Department of EECS, University of California, Berkeley.
-Maintained by the Berkeley Vision and Learning Center (BVLC).
+Created by [Yangqing Jia](http://daggerfs.com), UC Berkeley EECS department.
+In active development by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu/)).
## Introduction
@@ -48,22 +48,24 @@ Please kindly cite Caffe in your publications if it helps your research:
Howpublished = {\url{http://caffe.berkeleyvision.org/}
}
-## Contributing
+## Building documentation
+
+Tutorials and general documentation is 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`).
-Caffe is developed with the community by the [Berkeley Vision and Learning
-Center](http://bvlc.eecs.berkeley.edu/). We welcome contributions!
+We strive to provide provide lots of usage examples, and to document all code in docstrings.
+We'd appreciate your contribution to this effort!
+
+## Contributing
-To join in, please note this policy:
+Caffe is developed with active participation of the community by the [Berkeley Vision and Learning Center](http://bvlc.eecs.berkeley.edu/).
+We welcome all contributions!
-- Do your work in [feature
- branches](https://www.atlassian.com/git/workflows#!workflow-feature-branch).
-- Bring your work up-to-date by
- [rebasing](http://git-scm.com/book/en/Git-Branching-Rebasing) onto the latest
- `dev`. Polish your changes by [interactive
- rebase](https://help.github.com/articles/interactive-rebase) if you like too.
-- [Pull request](https://help.github.com/articles/using-pull-requests) your
- contribution to BVLC/caffe's `dev` branch for discussion and review.
-- `dev` is for new development, community contributions, and testing.
-- `master` is handled by BVLC, which will integrate changes from `dev`.
+Our workflow is this:
-Expect a more detailed contributing guide soon. Thank you.
+- The `dev` branch is for new development, community contributions, and testing.
+- The `master` branch is handled by BVLC, which will integrate changes from `dev` on a roughly monthly schedule.
+- Do new development in [feature branches](https://www.atlassian.com/git/workflows#!workflow-feature-branch) with decriptive names.
+- Bring your work up-to-date by [rebasing](http://git-scm.com/book/en/Git-Branching-Rebasing) onto the latest `dev`. (Polish your changes by [interactive rebase](https://help.github.com/articles/interactive-rebase), if you'd like.)
+- [Pull request](https://help.github.com/articles/using-pull-requests) your contribution to BVLC/caffe's `dev` branch for discussion and review.