cmake-basis / BASIS

CMake BASIS makes it easy to create sharable software and libraries that work together. This is accomplished by combining and documenting some of the best practices and utilities available. This project supplies a fully integrated suite of functionality to make the whole process seamless!
https://cmake-basis.github.io
Other
48 stars 10 forks source link

Suggestions to docs, chapter 2 #605

Open jvegh opened 8 years ago

jvegh commented 8 years ago

Referring to the PDF manual page 5 Press 'c' repeatedly to configure the project until 'g' appears in the menu BUILD_PROJECT_TOOL is to be removed

Page 6, and in general: prepend make install with sudo make consistent upper/lower case mismatches in hellobasis, etc

For basisproject create I would consider to default to --root ., when --root is missing; or at least mention what is the default.

Page 9, Note: build -> built

Page 10: make && make install : sudo might be missing export TOPLEVEL_DIR="~/local/src/HelloTopLevel" concert usage of quotations with the implementation. I guess that $HOME is a temporary solution. Similar to the rest of page.

Break lines like basisproject create --name moda --description "Subproject library to be used elsewhere" --root ${MODA

basisproject create --name modb --description "User example subproject executable utility repository (It might be critical when copy/paste-ing: characters at the end are missing)

Page 11: cmake -D CMAKE_INSTALL_PREFIX=~/local -D MODULE_moda=ON -D MODULE_modb=ON ..

It should be explained, what is the role of the switches: moda might be used also by modc

schuhschuh commented 8 years ago

Related to #601.