Installation: .sh files, CMake cache variables.

Author: rerdavies

CMakeLists.txt

@@ -13,8 +13,7 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 set(NWINDOWS_BUILD_DOCUMENTATION ON CACHE BOOL "Build the Vite Documentation website?")
 set(NWINDOWS_BUILD_EXAMPLES ON CACHE BOOL "Build the example projects?")
-# Set to ON if you wish to set compler options froma parent CMakeList.txt file.
-set(NWINDOWS_DEFAULT_COMPILER_OPTIONS OFF CACHE BOOL "Use default compiler options?")
+set(NWINDOWS_STRICT_COMPILER_OPTIONS ON CACHE BOOL "Use strict compiler warnings and errors?")
 
 # Set version numbers in source files.
 configure_file(
@@ -35,7 +34,7 @@ configure_file(
 
 
 
-if (NOT NWINDOWS_DEFAULT_COMPILER_OPTIONS)
+if (NWINDOWS_STRICT_COMPILER_OPTIONS)
 
     set(CMAKE_CXX_STANDARD 20)
 

build..sh

@@ -0,0 +1,2 @@
+#!/usr/bin/bash
+/usr/bin/cmake "$@" --build build --config RelWithDebInfo --target all 

init.sh configure.shinit.sh renamed to configure.sh

@@ -2,8 +2,8 @@
 
 # Configure cmake build.
 echo Configuring cmake build...
-mkdir build
+mkdir -p build
 cd build
-cmake ..
+cmake ..  "$@"
 cd ..
 

docs/src/pages/InstallingNWindows.tsx

@@ -56,7 +56,7 @@ sudo apt-get install ./yourpackagename`} />
                 <p>NWindows headers will be installed in the <M>/usr/include/NWindows</M> directory, 
                 and the <M>libnwindows.a</M> static library will be installed in the <M>/usr/lib</M> directory.</p>
 
-                <SectionHead text="Prerequisites"/>
+                <SectionHead text="Build Prerequisites"/>
                 <p>NWindows requires the following development tools to be installed.</p>
                 <ul>
                     <li>A reasonably modern compiler with support for C++20.</li>
@@ -165,6 +165,12 @@ git clone https://github.com/rerdavies/nwindows.git`
 ./install.sh     # Installs NWindows in /usr/local/include and /usr/local/lib`
                         } />
                     </li>
+                    <li>You can optionally build a debian package for NWindows using the following command:
+                        <Code style={{ marginTop: 16, marginBottom: 16 }} text={
+                            `./makePackage.sh`
+                        } />   
+                        <p>The Debian package will be placed in the <M>./build</M> directory of the NWindows project.</p> 
+                    </li>
                 </ul>
                 <SectionHead text="Building the Documentation" />
                 <p>
@@ -181,7 +187,28 @@ git clone https://github.com/rerdavies/nwindows.git`
                 <p>If you are using CMake, and building NWindows as a submodule, you can disable the documentation build by setting the <M>NWINDOWS_BUILD_DOCUMENTATION</M> variable to <M>OFF</M> in your top-level <M>CMakeLists.txt</M> file.</p>
                 <Code text={`set(NWINDOWS_BUILD_DOCUMENTATION OFF)`} />
             </div>
+            <SectionHead text="CMake Cache Variables" />
+            <p>The CMake build for NWindows uses the following cache variables: </p>
+            <Code text={`set(NWINDOWS_BUILD_DOCUMENTATION ON CACHE BOOL "Build the Vite Documentation website?")
+set(NWINDOWS_BUILD_EXAMPLES ON CACHE BOOL "Build the example projects?")
+set(NWINDOWS_STRICT_COMPILER_OPTIONS ON CACHE BOOL "Use strict compiler warnings and errors?")
+`} />
+            <p>By default, NWindows builds with strict compiler options:</p>
+            <Code text={`-Wall -Wextra -Wpedantic -Werror`} />
 
+            <p>Setting <M>NWINDOWS_STRICT_COMPILER_OPTIONS</M> to <M>OFF</M> will make Nwindows build without any of these
+            options.</p>
+            <p>If you are using NWindows as a git submodule, you can set these variables in your 
+                top-level <M>CMakeLists.txt</M> file to control the build of NWindows. For example, to disable building the documentation, add the following line to your top-level <M>CMakeLists.txt</M> file 
+            before adding the NWindows submodule directory:</p>
+            <Code text={`set(NWINDOWS_BUILD_DOCUMENTATION OFF)`} />
+            <p>If you are building NWindows as a standalone project, you can set these variables on the command line when 
+                running <M>cmake</M>. For example, to disable building the documentation, run the following command:</p>  
+            <Code text={`cmake -DNWINDOWS_BUILD_DOCUMENTATION=OFF ...`} />
+            <p><M>./init.sh</M> will accept additional command-line arguments that are 
+            passed through to CMake, so you can run:</p>
+            <Code text={`./init.sh -DNWINDOWS_BUILD_DOCUMENTATION=OFF`} />
+            <p>Because settings are cached, you do not need to specify these settings again when you run <M>./build.sh</M>.</p>
 
         </DocsPage>
     );

mk.sh

@@ -3,33 +3,8 @@ Blog examples:
 
     int button
     lost_mouse_capture
+    
+    set(NWINDOWS_DEFAULT_COMPILER_OPTIONS OFF CACHE BOOL "Use default compiler options?")
+    set(NWINDOWS_STRICT_COMPILER_OPTIONS ON CACHE BOOL "Use strict compiler warnings and errors?")
 
 
-usr/bin/c++ -O2 -g -DNDEBUG  examples/context_edit/CMakeFiles/context_edit.dir/context_edit.cpp.o 
-    -o examples/context_edit/context_edit  
-  src/libnwindows.a  -lpanelw  -lncursesw && :
-
-/usr/bin/c++ -O2 -g -DNDEBUG  
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/test_main.cpp.o 
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/box_test_window.cpp.o 
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/menu_test_window.cpp.o 
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/unicode_test_window.cpp.o 
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/edit_text_test_window.cpp.o 
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/error_test_window.cpp.o 
-    examples/nwindows_test/CMakeFiles/nwindows_test.dir/rendering_test_window.cpp.o 
-    -o examples/nwindows_test/nwindows_test  
-
-src/libnwindows.a  -lpanelw  -lncursesw  
-
-
-[build] /usr/bin/ld: examples/nwindows_test/CMakeFiles/nwindows_test.dir/box_test_window.cpp.o: in function 
-    `nwindows::NRadioGroupElement::create(nwindows::NOrientation, std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&, int)'
-    :
-[build] /home/robin/src/nwindows/src/include/NWindows/NWindows.hpp:1171:(.text._ZN8nwindows18NRadioGroupElement6createENS_12NOrientationERKSt6vectorINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEESaIS8_EEi[_ZN8nwindows18NRadioGroupElement6createENS_12NOrientationERKSt6vectorINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEESaIS8_EEi]+0x83): 
-    undefined reference to `nwindows::NRadioGroupElement::NRadioGroupElement(
-            nwindows::NOrientation, std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&, int, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)'
-[build] /usr/bin/ld: examples/nwindows_test/CMakeFiles/nwindows_test.dir/menu_test_window.cpp.o: in function `menu_test_window(std::shared_ptr<nwindows::NWindow>)::{lambda(nwindows::NMouseButton, nwindows::NClickedEventArgs&)#1}::operator()(nwindows::NMouseButton, nwindows::NClickedEventArgs&) const [clone .isra.0]':
-
-
-nwindows::NRadioGroupElement::NRadioGroupElement(nwindows::NOrientation, std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&, int, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)
-nwindows::NRadioGroupElement::NRadioGroupElement(nwindows::NOrientation, std::__debug::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&, int, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)