License and doxygen setup

4 files changed, 67 insertions, 3 deletions

diff --git a/Doxygen/doxyfig b/Doxygen/doxyfig
index 6274cfa..491cc58 100644
--- a/Doxygen/doxyfig
+++ b/Doxygen/doxyfig
@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING

 # Note: If this tag is empty the current directory is searched.

 

-INPUT                  = "../Src/"

+INPUT                  = "../Src/" "index.md"

 

 # This tag can be used to specify the character encoding of the source files

 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

@@ -1026,7 +1026,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub

 # and want to reuse the introduction page also for the doxygen output.

 

-USE_MDFILE_AS_MAINPAGE =

+USE_MDFILE_AS_MAINPAGE = index.md

 

 #---------------------------------------------------------------------------

 # Configuration options related to source browsing

diff --git a/Doxygen/doxyrun.sh b/Doxygen/doxyrun.sh
index b3dbc61..a8ae488 100644
--- a/Doxygen/doxyrun.sh
+++ b/Doxygen/doxyrun.sh
@@ -1 +1,9 @@
-sudo doxygen doxyfig
+# Copy repository readme here to be used as a cover page
+tail ../readme.md -n +2 > index.md
+
+# Run doxygen
+doxygen doxyfig
+
+# Cleanup index.md
+rm -f index.md
+
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d3ab329
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,26 @@
+BSD 2-Clause License

+

+Copyright (c) 2022, Leon Etienne

+All rights reserved.

+

+Redistribution and use in source and binary forms, with or without

+modification, are permitted provided that the following conditions are met:

+

+1. Redistributions of source code must retain the above copyright notice, this

+   list of conditions and the following disclaimer.

+

+2. Redistributions in binary form must reproduce the above copyright notice,

+   this list of conditions and the following disclaimer in the documentation

+   and/or other materials provided with the distribution.

+

+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+

diff --git a/readme.md b/readme.md
index 71c0e01..dfbc11a 100644
--- a/readme.md
+++ b/readme.md
@@ -3,3 +3,33 @@
 This really is nothing special.  
 The only reason for this repository being public is that a few of my more noteworthy projects depend on it as a git submodule.
 Users couldn't build them without being able to pull this repo as a submodule.
+
+# LICENSE
+```
+BSD 2-Clause License
+
+Copyright (c) 2022, Leon Etienne
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+