From 5d1ae13087593ce46854151cb30e8b0b117633ae Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Mon, 26 Aug 2024 23:01:20 -0700 Subject: [PATCH] Fix #78 Fix linking to the requirements --- README.md | 23 ++++++----------------- docs/pages/devdocs/install.dox | 15 +++++++++++++-- docs/pages/userdocs/install.dox | 8 ++++++-- 3 files changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e29a5f1f..095e8a0d 100644 --- a/README.md +++ b/README.md @@ -20,25 +20,14 @@ Below is a high-level overview of the project structure and capabilities we are ![Project Overview](resources/images/aqnwb_objective_500px.png) - - -## Requirements - -- **Minimum Requirements:** - - A C++17-compliant compiler - - [CMake >= 3.15](https://cmake.org) - - [HDF5 >= 1.10](https://github.com/HDFGroup/hdf5) - - [Boost](https://www.boost.org/) -- **Documentation:** Additional requirements for building the documentation (optional) - - [Doxygen](https://www.doxygen.nl/) - - [Graphviz](https://graphviz.org/) -- **For Developers:** Additional requirements for developers (mode `dev`) - - cppcheck - - clang-format (optional, required for ``target=format-check``, ``target=format-fix``) - - codespell (optional, required for ``target=spell-check``, ``target=spell-fix``) - ## Installation See the [AqNWB Documentation](https://neurodatawithoutborders.github.io/aqnwb/) for installation and integration instructions. * [User Installation](https://neurodatawithoutborders.github.io/aqnwb/install_page.html) * [Developer Installation](https://neurodatawithoutborders.github.io/aqnwb/dev_install_page.html) + +## Contributing and Legal + +For more information about licence, contributing guidelines, code of conduct +and other relevant documentation for developers please see the +[Developer Documentation](https://neurodatawithoutborders.github.io/aqnwb/devdocs.html). \ No newline at end of file diff --git a/docs/pages/devdocs/install.dox b/docs/pages/devdocs/install.dox index ac96f398..56a50558 100644 --- a/docs/pages/devdocs/install.dox +++ b/docs/pages/devdocs/install.dox @@ -4,8 +4,19 @@ * \section dev_requirements_sec Requirements * * Please ensure that the required libraries described in the - * \ref requirements "Requirements" section are installed. For developers we recommend - * to also install optional dependencies to ease development. + * \ref user_requirements_sec "User Requirements" section are installed. + * + * For developers we also recommend to install the following optional command line tools used for + * generating the documentation, for code quality checks, and for debugging. + * + * - **Documentation:** Additional requirements for building the documentation (optional) + * - [Doxygen](https://www.doxygen.nl/) + * - [Graphviz](https://graphviz.org/) + * - **Code checks:** Additional command line tools used in developer mode `dev` + * - cppcheck + * - clang-format (optional, required for ``target=format-check``, ``target=format-fix``) + * - codespell (optional, required for ``target=spell-check``, ``target=spell-fix``) + * * * \section devbuild_sec Developer Build * diff --git a/docs/pages/userdocs/install.dox b/docs/pages/userdocs/install.dox index 8fc41c83..5dc204bd 100644 --- a/docs/pages/userdocs/install.dox +++ b/docs/pages/userdocs/install.dox @@ -3,8 +3,12 @@ * * \section user_requirements_sec Requirements * - * Please ensure that the required libraries described in the - * \ref requirements "Requirements" section are installed. + * Please ensure that the required libraries are installed. + * + * - A C++17-compliant compiler + * - [CMake >= 3.15](https://cmake.org) + * - [HDF5 >= 1.10](https://github.com/HDFGroup/hdf5) + * - [Boost](https://www.boost.org/) * * \section userbuild_build_sec Build *