Updated README with doc info

diff --git a/.gitignore b/.gitignore
index c7d1751..ba5b34f 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -40,3 +40,4 @@ distribute/*
 
 # user's specified config
 Makefile.config
+docs/_site

diff --git a/README.md b/README.md
index 08a9fb8..bc1ec23 100644 (file)
--- 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.

diff --git a/build_and_deploy_docs.sh b/scripts/build_and_deploy_docs.sh
similarity index 78%
rename from build_and_deploy_docs.sh
rename to scripts/build_and_deploy_docs.sh
index b9de295..83b79b2 100755 (executable)
--- a/build_and_deploy_docs.sh
+++ b/scripts/build_and_deploy_docs.sh
@@ -6,7 +6,7 @@ ORIGIN=`git config --get remote.origin.url`
 BRANCH=`git rev-parse --abbrev-ref HEAD`
 MSG=`git log --oneline -1`
 
-if [ $BRANCH='master' ]; then
+if [ $BRANCH = 'master' ]; then
     # Make sure that docs/_site tracks remote:gh-pages.
     # If not, then we make a new repo and check out just that branch.
     mkdir docs/_site
@@ -14,11 +14,15 @@ if [ $BRANCH='master' ]; then
     SITE_ORIGIN=`git config --get remote.origin.url`
     SITE_BRANCH=`git rev-parse --abbrev-ref HEAD`
 
-    if [ $SITE_ORIGIN=$ORIGIN ] && [ $SITE_BRANCH='gh-pages' ]; then
+    echo $SITE_ORIGIN
+    echo $SITE_BRANCH
+    echo `pwd`
+
+    if [[ ( $SITE_ORIGIN == $ORIGIN ) && ( $SITE_BRANCH = 'gh-pages' ) ]]; then
         echo "Confirmed that docs/_site has same origin as main repo, and is on gh-pages."
     else
-        echo "Checking out origin:gh-pages into docs/_site."
-        git init
+        echo "Checking out origin:gh-pages into docs/_site (will take a little time)."
+        git init .
         git remote add -t gh-pages -f origin $ORIGIN
         git co gh-pages
     fi