Peter M. Groen / openbr

Commit 1af9c6ce003441823d000d260abbc6681f05cd7a

Authored by bhklein
1 parent 6ba71e0d

update installation instructions

Inline Side-by-side
Showing 1 changed file with 21 additions and 9 deletions
docs/docs/install.md
  View file @1af9c6c
... ... @@ -35,7 +35,7 @@ A hacker's guide to building, editing, and running OpenBR.
35 35  
36 36 $ git clone https://github.com/biometrics/openbr.git
37 37 $ cd openbr
38   - $ git checkout 0.5
  38 + $ git checkout 1.0
39 39 $ git submodule init
40 40 $ git submodule update
41 41  
... ... @@ -71,8 +71,14 @@ A hacker's guide to building, editing, and running OpenBR.
71 71 $ sudo cpack -G TGZ
72 72  
73 73 10. (Optional) Build OpenBR documentation!
  74 + 1. Build the docs
74 75  
75   -Need to rewrite this step for the new docs!
  76 + $ pip install mkdocs
  77 + $ cd openbr/docs
  78 + $ sh build_docs.sh
  79 + $ mkdocs serve
  80 +
  81 + 2. Navigate to `http://127.0.0.1:8000` in your browser to view the docs.
76 82  
77 83 ---
78 84  
... ... @@ -83,13 +89,13 @@ Need to rewrite this step for the new docs!
83 89 2. [Download CMake 3.0.2](http://www.cmake.org/files/v3.0/cmake-3.0.2.tar.gz)
84 90  
85 91 $ cd ~/Downloads
86   - $ tar -xf cmake-2.8.11.2.tar.gz
87   - $ cd cmake-2.8.11.2
  92 + $ tar -xf cmake-3.0.2.tar.gz
  93 + $ cd cmake-3.0.2
88 94 $ ./configure
89 95 $ make -j4
90 96 $ sudo make install
91 97 $ cd ..
92   - $ rm -rf cmake-2.8.11.2*
  98 + $ rm -rf cmake-3.0.2*
93 99  
94 100 3. [Download OpenCV 2.4.11](http://sourceforge.net/projects/opencvlibrary/files/opencv-unix/2.4.11/opencv-2.4.11.zip/download)
95 101  
... ... @@ -110,7 +116,7 @@ Need to rewrite this step for the new docs!
110 116  
111 117 $ git clone https://github.com/biometrics/openbr.git
112 118 $ cd openbr
113   - $ git checkout 0.5
  119 + $ git checkout 1.0
114 120 $ git submodule init
115 121 $ git submodule update
116 122  
... ... @@ -148,8 +154,14 @@ Need to rewrite this step for the new docs!
148 154  
149 155  
150 156 10. (Optional) Build OpenBR documentation!
  157 + 1. Build the docs
  158 +
  159 + $ pip install mkdocs
  160 + $ cd openbr/docs
  161 + $ sh build_docs.sh
  162 + $ mkdocs serve
151 163  
152   -Need to remake this step with the new docs!
  164 + 2. Navigate to `http://127.0.0.1:8000` in your browser to view the docs.
153 165  
154 166 ---
155 167  
... ... @@ -184,7 +196,7 @@ Need to remake this step with the new docs!
184 196 $ cd /c
185 197 $ git clone https://github.com/biometrics/openbr.git
186 198 $ cd openbr
187   - $ git checkout 0.5
  199 + $ git checkout 1.0
188 200 $ git submodule init
189 201 $ git submodule update
190 202  
... ... @@ -265,7 +277,7 @@ Need to remake this step with the new docs!
265 277  
266 278 $ git clone https://github.com/biometrics/openbr.git
267 279 $ cd openbr
268   - $ git checkout 0.5
  280 + $ git checkout 1.0
269 281 $ git submodule init
270 282 $ git submodule update
271 283  
... ...