Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Improving documentation based on user input. #336

Merged
merged 2 commits into from
Jan 19, 2018
Merged

DOC: Improving documentation based on user input. #336

merged 2 commits into from
Jan 19, 2018

Conversation

zivy
Copy link
Member

@zivy zivy commented Nov 6, 2017

Improving the build documentation based on user input from this
discourse discussion:
https://discourse.itk.org/t/using-cmake-to-build-simpleitk/373

Change-Id: Ifbcda487d58128e88c37ba21606448b26a6aa6c9

Improving the build documentation based on user input from this
discourse discussion:
https://discourse.itk.org/t/using-cmake-to-build-simpleitk/373

Change-Id: Ifbcda487d58128e88c37ba21606448b26a6aa6c9
@blowekamp
Copy link
Member

This is a good start but I think we need command line instruction that will work in a copy and paste way for MS Windows. Specifically, the build command have a path that is too long, and we should instruct using cmake --build <dir> instead of the general comment "use your build tool". The trick with that is ensuring the build tool compiles with multiple cores.


Words of caution for building on the Windows operating system:

* Visual studio has issues with long directory paths, we recommend cloning the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be more general here and just say, "Microsoft Windows has issues with"...

Previously said that "Visual studio has issues with long directory
paths...". This is a windows issue not specific to the visual studio
compiler, other compilers have the same problem.

Change-Id: I3dc7b7d13beb7330729dd0becbb3a6313c1e3331
@kwrobot kwrobot merged commit 7b5cabb into SimpleITK:next Jan 19, 2018
@zivy zivy deleted the updateSphinxDocumentation branch November 9, 2018 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants