Skip to content

Commit

Permalink
Typos and note for windows users
Browse files Browse the repository at this point in the history
  • Loading branch information
aaron-bray committed Jul 18, 2017
1 parent 5627c8a commit 72b4b57
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,12 @@ with the Fletch source directory for each desired configuration. For example :

========================== ===================================================================
``\fletch\src`` contains the code from the git repository
``\fletch\build\release`` contains the built files for the release configuration
``\fletch\build\debug`` contains the built files for the debug configuration
``\fletch\build\rel`` contains the built files for the release configuration
``\fletch\build\deb`` contains the built files for the debug configuration
========================== ===================================================================

** NOTE: Windows users, there is a known issue in Qt that will cause a build error if you name a build folder 'release' or 'debug' **

The recommended CMake configuration is to enable all packages and, if desired, python.

If you are using ccmake or the CMake GUI,
Expand All @@ -142,8 +144,8 @@ Running from a shell or cmd window::
# Pull the source into a subfolder 'src'
git clone https://github.com/Kitware/fletch.git src
# Create a folder to build in
mkdir build/release
cd build/release
mkdir build/rel
cd build/rel
# Note you need to provide cmake the source directory at the end (relative or absolute)
# Run CMake (it will use the system default compiler if you don't provide options or use the CMake GUI)
# Also, if using visual studio, you do no need to provide the build type
Expand All @@ -154,7 +156,7 @@ On Linux/OSX/MinGW, execute make

For MSVC users, open the generated fletch.sln and build the project in the configuration associated with the build folder.
Even though MSVC supports building multiple configurations, you should only build one configuration per build folder.
If you need multiple configurations you should create multiple subfolders and repeat the above insturctions for each configuration.
If you need multiple configurations you should create multiple subfolders and repeat the above instructions for each configuration.
Also If you enable Python, please ensure that python is on your Windows PATH

Getting Help
Expand Down

0 comments on commit 72b4b57

Please sign in to comment.