Merge pull request #40 from FluidNumerics/feature/docs

Feature/docs

.gitignore

@@ -5,3 +5,6 @@ build/
 *.i90
 *.code-workspace
 .vscode
+fpm
+check
+test.sh

CMakeLists.txt

@@ -1,3 +1,29 @@
+# ! //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// !
+# !
+# ! Maintainers : [email protected]
+# ! Official Repository : https://github.com/FluidNumerics/feq-parse/
+# !
+# ! Copyright © 2024 Fluid Numerics LLC
+# !
+# ! 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.
+# !
+# ! 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from 
+# !    this software without specific prior written permission.
+# !
+# ! 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.
+# !
+# ! //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// !
+
 CMAKE_MINIMUM_REQUIRED(VERSION 3.0.2)
 
 set(CMAKE_VERBOSE_MAKEFILE ON)

LICENSE

@@ -1,16 +1,11 @@
-LICENSE
-
 Copyright © 2024 Fluid Numerics LLC
 
-Permission is hereby granted, free of charge, to any person or organization (the "User") obtaining a copy of this software and associated documentation files (the "Software"), to use, copy, modify, merge, and/or distribute copies of the Software, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-1. The above copyright notice and this permission notice shall be included in all copies or modified versions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-2. The User is one of the following:
-a. An individual person, laboring for themselves
-b. A non-profit organization
-c. An educational institution
+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.
 
-4. If the User is an organization, then the User is not law enforcement or military, or working for or under either.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+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.

README.md

@@ -20,6 +20,9 @@ Copyright 2020 Fluid Numerics LLC
 
 [Learn how to contribute to this repository](./CONTRIBUTING.md)
 
+[**User Documentation**](https://feqparse.fluidnumerics.com/)
+[**API Documentation**](https://feqparse.fluidnumerics.com/ford)
+
 ## Installation
 `feq-parse` can be installed using either CMake, [Fortran Package Manager (fpm)](https://github.com/fortran-lang/fpm), or with [Spack](https://spack.io).
 

docs/build-with-feqparse.md

@@ -0,0 +1,51 @@
+# Build your application with feq-parse
+
+Once feq-parse is installed, you can use the library to start creating your own Fortran applications with dynamic equation support! Below, we provide example Makefiles and CMakeLists.txt to get your started. You can peruse the [feq-parse/example](https://github.com/FluidNumerics/feq-parse/tree/master/example) for demonstrations of how you can use `feq-parse` in your project.
+
+
+## Build
+
+When building an application with feqparse, you need to specify linker and includes flags to your Fortran compiler so that it can find the feqparse library and Fortran `.mod` files. Below are examples for doing this with a Makefile and with a CMake build system.
+
+### Makefile
+```
+FC?=gfortran # This needs to be the same Fortran compiler that was used to build feq-parse
+FEQPARSE_ROOT?=/usr  # Modify this line or set FEQPARSE_ROOT environment variable to the root installation path for feq-parse
+
+FEQPARSE_LIB=-L${FEQPARSE_ROOT}/lib/ -lfeqparse
+FEQPARSE_INCLUDE=-I${FEQPARSE_ROOT}/include
+
+app: app.o
+    ${FC} ${FEQPARSE_LIB} ${FEQPARSE_INCLUDE} app.o -o $@
+
+app.o:
+    ${FC} -c ${FEQPARSE_LIB} ${FEQPARSE_INCLUDE} app.f90 -o $@
+```
+
+### CMakeLists.txt
+
+```
+cmake_minimum_required(VERSION 3.21)
+cmake_policy(VERSION 3.21...3.27)
+
+project(myproject VERSION 1.0.0
+        DESCRIPTION "A totally useful application"
+        LANGUAGES Fortran)
+
+
+# FEQ-Parse
+find_library(FEQPARSE_LIBRARIES NAMES feqparse REQUIRED)
+find_path(FEQPARSE_INCLUDE_DIRS feqparse.mod)
+
+# After you declare your build targets, you can use:
+#
+#    target_link_libraries(target-name PRIVATE ${FEQPARSE_LIBRARIES})
+#
+# to link your target to the feq-parse library, and you can use :
+#
+#     target_include_directories(target-name PRIVATE ${FEQPARSE_INCLUDE_DIRS})
+#
+# to add the necessary includes flags to the feq-parse `.mod` files.
+#
+```
+