INTERFACES.md edition #4

iRmantou · 2017-03-04T11:20:46Z

I hope i could make the shogun Windows installation process become more accurate. If u find something wrong, please tell me. : )

vigsterkr

great stuff! thanks!
could you make those changes plz

vigsterkr · 2017-03-05T05:55:27Z

INSTALL.md

@@ -57,8 +57,29 @@ Shogun is part of [homebrew-science](https://github.com/Homebrew/homebrew-scienc
    $ sudo brew install shogun

 ###Windows <a name="windows"></a>
-Shogun natively compiles under Windows using MSVC, see the [CI build](https://ci.appveyor.com/project/vigsterkr/shogun). We currently do not support a binary
-installer. If you are interested in packaging, documenting, or contributing otherwise, please contact us.
+We currently do not support a Shogun binary on Windows platform. Shogun natively compiles under Windows using MSVC.We recommend using "Visual Studio 14 2015" which has a good support for C++11. If you do not want to install the whole IDE,you can just use MSBuild to build shogun. Running CMD as administrator with the following commands：


i know i'm nitpicking a bit but could you please make spaces between the comma and fullstop. like at using MSVC.We or whole IDE,you

Please read the develop readme for how to contribute to documentation.

This is our main point of contact with new people so it needs to be as precise and clean as possible. Avoid redundancy and unnecessary sentences. Be concise

ok，I will do these again and pay more attention on these places！3Q!

vigsterkr · 2017-03-05T05:57:35Z

INSTALL.md

+```
+cmake -G"Visual Studio 14 2015 Win64" -DCMAKE_BUILD_TYPE=Release -DBUILD_META_EXAMPLES=ON -DENABLE_TESTING=ON ..
+```
+This requires [PLY for Python](https://pypi.python.org/pypi/ply) package `python-ply` which you can use `pip install ply` to install it, and [ctags](http://ctags.sourceforge.net/), package `ctags`. Or you can ignore these two packages and use `-DBUILD_META_EXAMPLES=OFF` to continue. You can get the using of `DBUILD_META_EXAMPLES` on the [Examples](#manual-examples)


BUILD_META_EXAMPLES instead of DBUILD_META_EXAMPLES.

and for the last sentence use rather like: `For further information regarding the BUILD_META_EXAMPLES parameter please check out the Examples manual...

Okay, I'll change it right now

vigsterkr · 2017-03-13T12:17:44Z

INSTALL.md

@@ -57,7 +57,7 @@ Shogun is part of [homebrew-science](https://github.com/Homebrew/homebrew-scienc
    $ sudo brew install shogun

 ###Windows <a name="windows"></a>
-We currently do not support a Shogun binary on Windows platform. Shogun natively compiles under Windows using MSVC. It is recommended to use " Visual Studio 14 2015 " which has a good support for C++11, or you can only use " MSBuild " to build Shogun. Run CMD as administrator with the following commands：
+We currently do not support a Shogun binary on Windows platform. Shogun natively compiles under Windows using MSVC. It is recommended to use " Visual Studio 14 2015 " or " MSBuild " to build Shogun which both have good support to C++11. Run CMD as administrator with the following commands：


support for and use, i.e. **** for emphasizing things.

"we currently do not provide a Shogun binary for Windows platform."

karlnapf · 2017-03-13T12:59:12Z

Also please read the develop.md readme on how your commits can be squashed

Signed-off-by: iRmantou <irbaozi@gmail.com>

iRmantou · 2017-03-13T15:10:53Z

I am sorry for many commits, I have squashed them and read develop.md carefully, this won't happen again

vigsterkr · 2017-03-13T15:11:45Z

@iRmantou that's ok... nobody was born with git skills....

vigsterkr · 2017-03-13T16:33:38Z

@karlnapf care to take a peep on it?

karlnapf · 2017-03-15T11:02:13Z

INSTALL.md

@@ -57,8 +57,27 @@ Shogun is part of [homebrew-science](https://github.com/Homebrew/homebrew-scienc
    $ sudo brew install shogun

 ###Windows <a name="windows"></a>
-Shogun natively compiles under Windows using MSVC, see the [CI build](https://ci.appveyor.com/project/vigsterkr/shogun). We currently do not support a binary
-installer. If you are interested in packaging, documenting, or contributing otherwise, please contact us.
+We currently do not support a Shogun binary on Windows platform. Shogun natively compiles under Windows using MSVC. It is recommended to use " Visual Studio 14 2015 " or " MSBuild " to build Shogun which both have good support to C++11. 


"We currently do not offer a pre-compiled binary for Windows. If you are interested in packaging, documenting, or contributing otherwise, please contact us. For compiling Shogun natively compiles under Windows using MSVC, see below."

(You are in the precompiled binaries section here, the compiling from source section is below)

karlnapf · 2017-03-15T11:03:49Z

INSTALL.md

-installer. If you are interested in packaging, documenting, or contributing otherwise, please contact us.
+We currently do not support a Shogun binary on Windows platform. Shogun natively compiles under Windows using MSVC. It is recommended to use " Visual Studio 14 2015 " or " MSBuild " to build Shogun which both have good support to C++11. 
+
+Run CMD as administrator with the following commands：


The git cloning is already described above, so this is not really needed here.

karlnapf · 2017-03-15T11:04:08Z

INSTALL.md

+
+Run CMD as administrator with the following commands：
+```
+git clone https://github.com/shogun-toolbox/shogun.git C:\projects\shogun 


We use a $ sign for code, check out the other parts of the readme

@karlnapf $ only makes sense in *NIX world... not in case of windows...

ah yeah ok. I just dont like this triple quotation marks to make markdown render it as code

karlnapf · 2017-03-15T11:06:02Z

INSTALL.md

+cd C:\projects\shogun
+md build && cd build
+```
+You need [CMake](https://cmake.org/download/) to build Shogun. If you need Shogun examples in build, please see [Examples](#manual-examples).


This is already described above

karlnapf · 2017-03-15T11:06:05Z

INSTALL.md

+git submodule -q update --init
+```
+Move to the source tree root and create the build directory.
+```


This is already described above

karlnapf · 2017-03-15T11:09:01Z

INSTALL.md

+```
+You need [CMake](https://cmake.org/download/) to build Shogun. If you need Shogun examples in build, please see [Examples](#manual-examples).
+```
+cmake -G"Visual Studio 14 2015 Win64" -DCMAKE_BUILD_TYPE=Release -DBUILD_META_EXAMPLES=OFF -DENABLE_TESTING=ON ..


This is the crucial part.
You need to move this to the "Compiling by hand" section below.
Add a subsection called Windows and put the cmake and compile command there. It just needs to be these two lines as the rest is already described

karlnapf · 2017-03-15T11:10:45Z

INSTALL.md

+```
+msbuild "C:\projects\shogun\build\shogun.sln" /verbosity:minimal /t:Clean /p:Configuration=Release /p:Platform=x64
+```
+Note: If you use `/m` in msbuild command without specifying the number, it may occur out of memory errors. See [CI build](https://ci.appveyor.com/project/vigsterkr/shogun) as a reference and [Compiling manually](#manual) for more details. If you are interested in packaging, documenting, or contributing otherwise, please contact us.


"Note: If you use /m in msbuild command without specifying the number, it may occur out of memory errors. See CI build as a setup reference."

karlnapf

Pls move your instructions to the "Compiling by hand section, under a new subsection called "Windows". Just put the cmake and compile command. Reference this in the TOC on top.

karlnapf · 2017-03-15T11:12:01Z

INSTALL.md

+```
+Compile
+```
+msbuild "C:\projects\shogun\build\shogun.sln" /verbosity:minimal /t:Clean /p:Configuration=Release /p:Platform=x64


Please use the $ for code snippets, as in the rest of the readme

Sorry, I have been working on #3686 and I have sent a pr about it, I want to finish this after #3686, but I see u have added these to docs. Thank u : ）

Yeah I hope you dont mind I took your changes, I was doing a general edit of the files and thought I might just include it.
Thanks a lot for that, it will be helpful for people

I am happy to help this，thank u too

vigsterkr suggested changes Mar 5, 2017

View reviewed changes

vigsterkr reviewed Mar 13, 2017

View reviewed changes

Update INSTALL.md

3c5778d

Signed-off-by: iRmantou <irbaozi@gmail.com>

karlnapf reviewed Mar 15, 2017

View reviewed changes

karlnapf suggested changes Mar 15, 2017

View reviewed changes

karlnapf reviewed Mar 15, 2017

View reviewed changes

karlnapf closed this Mar 20, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

INTERFACES.md edition #4

INTERFACES.md edition #4

iRmantou commented Mar 4, 2017

vigsterkr left a comment

vigsterkr Mar 5, 2017

karlnapf Mar 5, 2017

iRmantou Mar 12, 2017

vigsterkr Mar 5, 2017

iRmantou Mar 12, 2017

vigsterkr Mar 13, 2017

karlnapf commented Mar 13, 2017

iRmantou commented Mar 13, 2017

vigsterkr commented Mar 13, 2017

vigsterkr commented Mar 13, 2017

karlnapf Mar 15, 2017 •

edited

karlnapf Mar 15, 2017 •

edited

karlnapf Mar 15, 2017

vigsterkr Mar 15, 2017

karlnapf Mar 15, 2017

karlnapf Mar 15, 2017

karlnapf Mar 15, 2017

karlnapf Mar 15, 2017

karlnapf Mar 15, 2017

karlnapf left a comment

karlnapf Mar 15, 2017

iRmantou Mar 19, 2017

karlnapf Mar 20, 2017

iRmantou Mar 20, 2017

INTERFACES.md edition #4

INTERFACES.md edition #4

Conversation

iRmantou commented Mar 4, 2017

vigsterkr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karlnapf commented Mar 13, 2017

iRmantou commented Mar 13, 2017

vigsterkr commented Mar 13, 2017

vigsterkr commented Mar 13, 2017

karlnapf Mar 15, 2017 • edited

Choose a reason for hiding this comment

karlnapf Mar 15, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karlnapf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karlnapf Mar 15, 2017 •

edited

karlnapf Mar 15, 2017 •

edited