aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-11 23:47:56 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-10-11 23:47:56 -0400
commit1b2faa19df53008a88a16913644e478e58da5c78 (patch)
treed079b3c33acc125b179dffc0159616e249e25112 /README
parent9764fdc458ac8eb282d7cae10d43309e13f91fa0 (diff)
downloadlibrambutan-1b2faa19df53008a88a16913644e478e58da5c78.tar.gz
librambutan-1b2faa19df53008a88a16913644e478e58da5c78.zip
switching docs to leaflabs fork of breathe
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 7 insertions, 4 deletions
diff --git a/README b/README
index b8bf19d..b467d2d 100644
--- a/README
+++ b/README
@@ -8,11 +8,14 @@ You need a recent-ish version of doxygen in your PATH:
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
For the Doxygen-to-Sphinx bridge, we rely on a project called Breathe,
-by Michael Jones. You must clone the breathe repository and set an
-environment variable BREATHE_HOME to be able to build the
-documentation. Something like this on bash:
+by Michael Jones.
- $ git clone http://github.com/michaeljones/breathe.git
+***** You must clone the LEAFLABS VERSION OF THE breathe repository ******
+
+ ... and then set an environment variable BREATHE_HOME to be able to
+build the documentation. Something like this on bash:
+
+ $ git clone git@github.com:leaflabs/breathe.git
$ export BREATHE_HOME=/path/to/breathe/repo/
You can now build the HTML docs with (on Unix):