@@ -17,31 +17,38 @@ libraries or header files to compile shogun or its interfaces.
1717
1818## Download sources
1919
20- The following commands will get the prepared shogun source archives. If
21- you choose to fetch "shogun-data" as well, approximately 250 MB of data
22- will be downloaded.
20+ The following commands will get the prepared shogun source archives. Note
21+ that some examples might depend on "shogun-data", which is approximately
22+ 250 MB of data to be downloaded. The additional data is not required for
23+ shogun itself, so you may skip downloading them.
2324
2425```
2526
27+ $ cd "$HOME"
2628$ wget ftp://shogun-toolbox.org/shogun/releases/3.1/sources/shogun-3.1.1.tar.bz2
2729$ tar xjf shogun-3.1.1.tar.bz2
2830
2931$ wget ftp://shogun-toolbox.org/shogun/data/shogun-data-0.7.tar.bz2
3032$ shogun-data-0.7.tar.bz2
3133
34+ $ cd shogun-3.1.1
3235$ rm data/
3336$ ln -s ../shogun-data-0.7 data
3437```
3538
3639## Compile and install SHOGUN-TOOLBOX into home directory
3740
41+ We assume that you want to install shogun in a subdirectory ` shogun-install ` of
42+ your user home. Installing shogun to system-directories is possible as well,
43+ but may require root/sudo privileges.
44+
3845```
3946
40- $ cd shogun-3.1.1
47+ $ cd "$HOME/ shogun-3.1.1"
4148
4249$ mkdir build
4350$ cd build
44- $ cmake -DCMAKE_INSTALL_PREFIX="/home/$USER /shogun-install" ..
51+ $ cmake -DCMAKE_INSTALL_PREFIX="$HOME /shogun-install" ..
4552
4653$ make -j5 all
4754$ make install
@@ -56,8 +63,8 @@ should work well:
5663
5764```
5865
59- $ export LD_LIBRARY_PATH="/home/$USER /shogun-install/lib:$LD_LIBRARY_PATH"
60- $ cd "/home/$USER /share/shogun/examples/libshogun"
66+ $ export LD_LIBRARY_PATH="$HOME /shogun-install/lib:$LD_LIBRARY_PATH"
67+ $ cd "$HOME/shogun-install /share/shogun/examples/libshogun"
6168$ chmod +x ./so_multiclass_BMRM && ./so_multiclass_BMRM
6269```
6370
@@ -79,11 +86,10 @@ those you know what they do.
7986## Handy cmake options
8087* ` -DCMAKE_BUILD_TYPE=Debug ` or ` -DCMAKE_BUILD_TYPE=Release `
8188* ` -DENABLE_TESTING=ON ` or ` -DENABLE_TESTING=OFF `
82- * ` -DCMAKE_INCLUDE_PATH=... `
83- * ` -DCMAKE_LIBRARY_PATH=... `
89+ * ` -DCMAKE_INCLUDE_PATH=... ` , ` -DCMAKE_LIBRARY_PATH=... `
8490
8591# Got stuck? Found a bug? Need help?
8692
8793* Bug tracker: https://github.com/shogun-toolbox/shogun/issues
88- * IRC chat: Channel #shogun at irc.freenode.net
89- * Mailing list: shogun-list-subscribe@shogun-toolbox.org
94+ * Chat: Join IRC channel #shogun at irc.freenode.net
95+ * Mailing list: Send an empty message to shogun-list-subscribe@shogun-toolbox.org
0 commit comments