Skip to content

Commit 1f18c24

Browse files
authored
docs: Update README.md to CommonMark
1 parent fe42215 commit 1f18c24

File tree

1 file changed

+41
-50
lines changed

1 file changed

+41
-50
lines changed

README.md

Lines changed: 41 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ When you report USB issues, please attach relevant debug log from running the pr
118118

119119
Open a Git shell (GitHub for Windows), or any shell that has access to git.exe and msbuild.exe
120120
```
121-
cd depends/
122-
.\install_libusb_vs2013.cmd
123-
```
121+
cd depends/
122+
.\install_libusb_vs2013.cmd
123+
```
124124
Or `install_libusb_vs2015.cmd`. If you see some errors, you can always open the cmd files and follow the git commands, and maybe build `libusb_201x.sln` with Visual Studio by hand. Building with "Win32" is not recommended as it results in lower performance.
125125
* Install TurboJPEG
126126
@@ -139,10 +139,10 @@ cd depends/
139139
140140
The default installation path is `install`, you may change it by editing `CMAKE_INSTALL_PREFIX`.
141141
```
142-
mkdir build && cd build
143-
cmake .. -G "Visual Studio 12 2013 Win64"
144-
cmake --build . --config RelWithDebInfo --target install
145-
```
142+
mkdir build && cd build
143+
cmake .. -G "Visual Studio 12 2013 Win64"
144+
cmake --build . --config RelWithDebInfo --target install
145+
```
146146
Or `-G "Visual Studio 14 2015 Win64"`.
147147
* Run the test program: `.\install\bin\Protonect.exe`, or start debugging in Visual Studio.
148148
* Test OpenNI2 (optional)
@@ -155,64 +155,56 @@ Use your favorite package managers (brew, ports, etc.) to install most if not al
155155
156156
* Make sure these build tools are available: wget, git, cmake, pkg-config. Xcode may provide some of them. Install the rest via package managers.
157157
* Download libfreenect2 source
158-
159158
```
160-
git clone https://github.com/OpenKinect/libfreenect2.git
161-
cd libfreenect2
162-
```
159+
git clone https://github.com/OpenKinect/libfreenect2.git
160+
cd libfreenect2
161+
```
163162
* Install dependencies: libusb, GLFW
164-
165163
```
166-
brew update
167-
brew install libusb
168-
brew tap homebrew/versions
169-
brew install glfw3
170-
```
164+
brew update
165+
brew install libusb
166+
brew tap homebrew/versions
167+
brew install glfw3
168+
```
171169
* Install TurboJPEG (optional)
172-
173170
```
174-
brew tap homebrew/science
175-
brew install jpeg-turbo
176-
```
171+
brew tap homebrew/science
172+
brew install jpeg-turbo
173+
```
177174
* Install CUDA (optional): TODO
178175
* Install OpenNI2 (optional)
179-
180176
```
181-
brew install openni2
182-
export OPENNI2_REDIST=/usr/local/lib/ni2
183-
export OPENNI2_INCLUDE=/usr/local/include/ni2
184-
```
177+
brew install openni2
178+
export OPENNI2_REDIST=/usr/local/lib/ni2
179+
export OPENNI2_INCLUDE=/usr/local/include/ni2
180+
```
185181
* Build
186-
187182
```
188-
mkdir build && cd build
189-
cmake ..
190-
make
191-
make install
192-
```
183+
mkdir build && cd build
184+
cmake ..
185+
make
186+
make install
187+
```
193188
* Run the test program: `./bin/Protonect`
194189
* Test OpenNI2. `make install-openni2` (may need sudo), then run `NiViewer`. Environment variable `LIBFREENECT2_PIPELINE` can be set to `cl`, `cuda`, etc to specify the pipeline.
195-
```
190+
196191
### Linux
197192
198193
Note: Ubuntu 12.04 is too old to support. Debian jessie may also be too old, and Debian stretch is implied in the following.
199194
200195
* Download libfreenect2 source
201-
202196
```
203-
git clone https://github.com/OpenKinect/libfreenect2.git
204-
cd libfreenect2
205-
```
197+
git clone https://github.com/OpenKinect/libfreenect2.git
198+
cd libfreenect2
199+
```
206200
* (Ubuntu 14.04 only) Download upgrade deb files
207-
208201
```
209-
cd depends; ./download_debs_trusty.sh
210-
```
202+
cd depends; ./download_debs_trusty.sh
203+
```
211204
* Install build tools
212-
213205
```
214-
sudo apt-get install build-essential cmake pkg-config
215-
```
206+
sudo apt-get install build-essential cmake pkg-config
207+
```
216208
* Install libusb. The version must be >= 1.0.20.
217209
1. (Ubuntu 14.04 only) `sudo dpkg -i debs/libusb*deb`
218210
2. (Other) `sudo apt-get install libusb-1.0-0-dev`
@@ -244,14 +236,13 @@ sudo apt-get install build-essential cmake pkg-config
244236
1. (Ubuntu 14.04 only) `sudo apt-add-repository ppa:deb-rob/ros-trusty && sudo apt-get update` (You don't need this if you have ROS repos), then `sudo apt-get install libopenni2-dev`
245237
2. (Other) `sudo apt-get install libopenni2-dev`.
246238
* Build
247-
248239
```
249-
cd ..
250-
mkdir build && cd build
251-
cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/freenect2
252-
make
253-
make install
254-
```
240+
cd ..
241+
mkdir build && cd build
242+
cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/freenect2
243+
make
244+
make install
245+
```
255246
You need to specify `cmake -Dfreenect2_DIR=$HOME/freenect2/lib/cmake/freenect2` for CMake based third-party application to find libfreenect2.
256247
* Set up udev rules for device access: `sudo cp ../platform/linux/udev/90-kinect2.rules /etc/udev/rules.d/`, then replug the Kinect.
257248
* Run the test program: `./bin/Protonect`

0 commit comments

Comments
 (0)