From 443620a653c2b01b59552e71e3d716d680a28c54 Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Thu, 15 Aug 2024 15:34:12 -0700 Subject: [PATCH] Add legal abd build instructions to the docs --- README.md | 170 -------------------- docs/Doxyfile.in | 2 +- docs/pages/0_install.dox | 126 +++++++++++++++ docs/pages/{userdocs.dox => 1_userdocs.dox} | 4 +- docs/pages/2_devdocs.dox | 11 ++ docs/pages/devdocs.dox | 7 - docs/pages/devdocs/code_of_conduct.dox | 7 + docs/pages/devdocs/copyright.dox | 6 + docs/pages/devdocs/license.dox | 6 + 9 files changed, 159 insertions(+), 180 deletions(-) create mode 100644 docs/pages/0_install.dox rename docs/pages/{userdocs.dox => 1_userdocs.dox} (75%) create mode 100644 docs/pages/2_devdocs.dox delete mode 100644 docs/pages/devdocs.dox create mode 100644 docs/pages/devdocs/code_of_conduct.dox create mode 100644 docs/pages/devdocs/copyright.dox create mode 100644 docs/pages/devdocs/license.dox diff --git a/README.md b/README.md index 78f6f6bd..a42c5cd8 100644 --- a/README.md +++ b/README.md @@ -19,176 +19,6 @@ Below is a high-level overview of the project structure and capabilities we are ![Project Overview](resources/images/aqnwb_objective_500px.png) -# Requirements -* A C++17-compliant compiler -* CMake `>= 3.15` -* HDF5 `>= 1.10` -* Boost -* Additional requirements for building the documentation (optional) - * Doxygen - * Graphviz -* Additional requirements for developers (mode `dev`) - * cppcheck - * clang-format -# Building and installing -## Build -Here are the steps for building in release mode with a multi-configuration generator: - -```sh -cmake -S . -B build -cmake --build build --config Release -``` - -Note, if you are using custom installations of HDF5 or BOOST that are not being detected -automatically by cmake, you can specify `HDF5_ROOT` and `BOOST_ROOT` environment variables to -point to install directories of HDF5 and BOOST respectively. - - -## Install - -Here is the command for installing the release mode artifacts with a -multi-configuration generator: - -```sh -cmake --install build --config Release -``` - -## Developing - -Build system targets that are only useful for developers of this project are -hidden if the `aq-nwb_DEVELOPER_MODE` option is disabled. Enabling this -option makes tests and other developer targets and options available. You can enable -the option when configuring the build by adding ``-Daq-nwb_DEVELOPER_MODE=ON``, e.g.,: - -```sh -cmake -S . -B build -Daq-nwb_DEVELOPER_MODE=ON -``` -### Presets - -As a developer, you can create your own dev preset by making a `CMakeUserPresets.json` file at the root of -the project: - -```json -{ - "version": 2, - "cmakeMinimumRequired": { - "major": 3, - "minor": 15, - "patch": 0 - }, - "configurePresets": [ - { - "name": "dev", - "binaryDir": "${sourceDir}/build/dev", - "inherits": ["dev-mode", "ci-"], - "cacheVariables": { - "CMAKE_BUILD_TYPE": "Debug" - } - } - ], - "buildPresets": [ - { - "name": "dev", - "configurePreset": "dev", - "configuration": "Debug" - } - ], - "testPresets": [ - { - "name": "dev", - "configurePreset": "dev", - "configuration": "Debug", - "output": { - "outputOnFailure": true - } - } - ] -} -``` -Replace `` in the `CmakeUserPresets.json` file with the name of -the operating system you have (`win64`, `linux` or `darwin`). - -### Configure, build and test - -You can configure, build and test the project respectively with the following commands from the project root on -any operating system with any build system: - -```sh -cmake --preset=dev -cmake --build --preset=dev -ctest --preset=dev -``` - -### Developer mode targets - -Additional targets can be invoked when in development mode using the commands below - -```sh -cmake --build --preset=dev --target= -``` - -#### Target options -- `format-check` and `format-fix`: run the clang-format tool on the codebase to check errors and to fix them respectively. -- `spell-check` and `spell-fix`: run the codespell tool on the codebase to check errors and to fix them respectively. -- `docs` : builds to documentation using Doxygen. (Note: run `cmake --preset=dev -DBUILD_DOCS=ON` before building to add docs target) - -# Code of Conduct - -This project and everyone participating in it is govered by our [code of conduct guidelines](https://github.com/NeurodataWithoutBorders/aqnwb/blob/main/.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. - -# LICENSE - -AqNWB Copyright (c) 2024, The Regents of the University of California, -through Lawrence Berkeley National Laboratory (subject to receipt of any -required approvals from the U.S. Dept. of Energy). 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. - -(3) Neither the name of the University of California, Lawrence Berkeley -National Laboratory, U.S. Dept. of Energy 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 OWNER 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. - -You are under no obligation whatsoever to provide any bug fixes, patches, -or upgrades to the features, functionality or performance of the source -code ("Enhancements") to anyone; however, if you choose to make your -Enhancements available either publicly, or directly to Lawrence Berkeley -National Laboratory, without imposing a separate written license agreement -for such Enhancements, then you hereby grant the following license: a -non-exclusive, royalty-free perpetual license to install, use, modify, -prepare derivative works, incorporate into other computer software, -distribute, and sublicense such enhancements or derivative works thereof, -in binary and source code form. - -# COPYRIGHT - -AqNWB Copyright (c) 2024, The Regents of the University of California, -through Lawrence Berkeley National Laboratory (subject to receipt of any -required approvals from the U.S. Dept. of Energy). All rights reserved. - -If you have questions about your rights to use or distribute this software, -please contact Berkeley Lab's Intellectual Property Office at -IPO@lbl.gov. - -NOTICE. This Software was developed under funding from the U.S. Department -of Energy and the U.S. Government consequently retains certain rights. As -such, the U.S. Government has been granted for itself and others acting on -its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the -Software to reproduce, distribute copies to the public, prepare derivative -works, and perform publicly and display publicly, and to permit others to do so. diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 0873ef12..cb13342e 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -8,7 +8,7 @@ PROJECT_NUMBER = "@PROJECT_VERSION@" # Add sources INPUT = "@PROJECT_SOURCE_DIR@/README.md" "@PROJECT_SOURCE_DIR@/src" "@PROJECT_SOURCE_DIR@/docs/pages" -EXAMPLE_PATH = "@PROJECT_SOURCE_DIR@/tests" +EXAMPLE_PATH = "@PROJECT_SOURCE_DIR@/tests" "@PROJECT_SOURCE_DIR@/.github/CODE_OF_CONDUCT.md" "@PROJECT_SOURCE_DIR@/Legal.txt" "@PROJECT_SOURCE_DIR@/LICENSE" IMAGE_PATH = "@PROJECT_SOURCE_DIR@/resources/images" EXTRACT_ALL = YES RECURSIVE = YES diff --git a/docs/pages/0_install.dox b/docs/pages/0_install.dox new file mode 100644 index 00000000..5f836e3f --- /dev/null +++ b/docs/pages/0_install.dox @@ -0,0 +1,126 @@ +/** + * @page install_page Installing AqNWB + * + * \section requirements Requirements + * - A C++17-compliant compiler + * - CMake >= 3.15 + * - HDF5 >= 1.10 + * - Boost + * - Additional requirements for building the documentation (optional) + * - Doxygen + * - Graphviz + * - Additional requirements for developers (mode `dev`) + * - cppcheck + * - clang-format + * + * \section userbuild_sec User Build + * + * \subsection userbuild_build_subsec Build + * + * Here are the steps for building in release mode with a multi-configuration generator: + * + * \code{.sh} + * cmake -S . -B build + * cmake --build build --config Release + * \endcode + * + * Note, if you are using custom installations of HDF5 or BOOST that are not being detected + * automatically by cmake, you can specify `HDF5_ROOT` and `BOOST_ROOT` environment variables to + * point to install directories of HDF5 and BOOST respectively. + * + * \subsection userbuild_install_subsec Install + * + * Here is the command for installing the release mode artifacts with a + * multi-configuration generator: + * + * \code{.sh} + * cmake --install build --config Release + * \endcode + * + * + * + * \section devbuild_sec Developer Build + * + * Build system targets that are only useful for developers of AqNWB are + * hidden if the `aq-nwb_DEVELOPER_MODE` option is disabled. Enabling this + * option makes tests and other developer targets and options available. You can enable + * the option when configuring the build by adding `-Daq-nwb_DEVELOPER_MODE=ON`, e.g., + * + * \code{.sh} + * cmake -S . -B build -Daq-nwb_DEVELOPER_MODE=ON + * \endcode + * + * \subsection devbuild_presets_subsec Presets + * + * As a developer, you can create your own dev preset by making a `CMakeUserPresets.json` file at the root of + * the project: + * + * \code{.json} + * { + * "version": 2, + * "cmakeMinimumRequired": { + * "major": 3, + * "minor": 15, + * "patch": 0 + * }, + * "configurePresets": [ + * { + * "name": "dev", + * "binaryDir": "${sourceDir}/build/dev", + * "inherits": ["dev-mode", "ci-"], + * "cacheVariables": { + * "CMAKE_BUILD_TYPE": "Debug" + * } + * } + * ], + * "buildPresets": [ + * { + * "name": "dev", + * "configurePreset": "dev", + * "configuration": "Debug" + * } + * ], + * "testPresets": [ + * { + * "name": "dev", + * "configurePreset": "dev", + * "configuration": "Debug", + * "output": { + * "outputOnFailure": true + * } + * } + * ] + * } + * \endcode + * Replace `` in the `CMakeUserPresets.json` file with the name of + * the operating system you have (`win64`, `linux` or `darwin`). + * + * \subsection configure_build_test Configure, build and test + * + * You can configure, build and test the project respectively with the following commands from the project root on + * any operating system with any build system: + * + * \code{.sh} + * cmake --preset=dev + * cmake --build --preset=dev + * ctest --preset=dev + * \endcode + * + * \subsection devbuild_dev_mode_targets_subsec Developer mode targets + * + * Additional targets can be invoked when in development mode using the commands below + * + * \code{.sh} + * cmake --build --preset=dev --target= + * \endcode + * + * \subsubsection devbuild_target_options_subsubsec Target options + * - `format-check` and `format-fix`: run the clang-format tool on the codebase to check errors and to fix them respectively. + * - `spell-check` and `spell-fix`: run the codespell tool on the codebase to check errors and to fix them respectively. + * - `docs` : builds the documentation using Doxygen. (Note: run `cmake --preset=dev -DBUILD_DOCS=ON` before building to add docs target) + */ + + + + + */ diff --git a/docs/pages/userdocs.dox b/docs/pages/1_userdocs.dox similarity index 75% rename from docs/pages/userdocs.dox rename to docs/pages/1_userdocs.dox index a2078142..6c4c1f1c 100644 --- a/docs/pages/userdocs.dox +++ b/docs/pages/1_userdocs.dox @@ -1,8 +1,8 @@ /** - * @page userdocs User Documentation + * @page userdocs For Users * * This documentation is intended for users of AqNWB, e.g., developers seeking to integrate NWB * with a particular data acquisition software via AqNWB. * - * @subpage hdf5io + * - @subpage hdf5io */ diff --git a/docs/pages/2_devdocs.dox b/docs/pages/2_devdocs.dox new file mode 100644 index 00000000..c0ab3880 --- /dev/null +++ b/docs/pages/2_devdocs.dox @@ -0,0 +1,11 @@ +/** + * @page devdocs For Developers + * + * This documentation is intended for developers of AqNWB. + * + * - @subpage testing + * - @subpage code_of_conduct_page + * - @subpage license_page + * - @subpage copyright_page + * + */ diff --git a/docs/pages/devdocs.dox b/docs/pages/devdocs.dox deleted file mode 100644 index cde46058..00000000 --- a/docs/pages/devdocs.dox +++ /dev/null @@ -1,7 +0,0 @@ -/** - * @page devdocs For Developers - * - * This documentation is intended for developers of AqNWB. - * - * @subpage testing - */ diff --git a/docs/pages/devdocs/code_of_conduct.dox b/docs/pages/devdocs/code_of_conduct.dox new file mode 100644 index 00000000..24d0364f --- /dev/null +++ b/docs/pages/devdocs/code_of_conduct.dox @@ -0,0 +1,7 @@ +/** + * @page code_of_conduct_page Code of Conduct + * + * This project and everyone participating in it is governed by our code of conduct guidelines. By participating, you are expected to uphold this code. + * \include CODE_OF_CONDUCT.md + */ + diff --git a/docs/pages/devdocs/copyright.dox b/docs/pages/devdocs/copyright.dox new file mode 100644 index 00000000..8f6532be --- /dev/null +++ b/docs/pages/devdocs/copyright.dox @@ -0,0 +1,6 @@ +/** + * @page copyright_page Copyright + * + * \include Legal.txt + */ + diff --git a/docs/pages/devdocs/license.dox b/docs/pages/devdocs/license.dox new file mode 100644 index 00000000..7b57b4a5 --- /dev/null +++ b/docs/pages/devdocs/license.dox @@ -0,0 +1,6 @@ +/** + * @page license_page License + * + * \include LICENSE + */ +