Skip to content

Commit

Permalink
Merge pull request #111 from NeurodataWithoutBorders/add/clone_url
Browse files Browse the repository at this point in the history
Update the installation docs to clarify where the sources are
  • Loading branch information
stephprince authored Nov 18, 2024
2 parents f9f987b + b93127c commit 186f207
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/pages/devdocs/install.dox
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@
* \section dev_requirements_sec Requirements
*
* Please ensure that the required libraries described in the
* \ref user_requirements_sec "User Requirements" section are installed.
* \ref user_requirements_sec "User Requirements" section are installed and
* clone the latest AqNWB source via:
*
* \code{.sh}
* git clone https://github.com/NeurodataWithoutBorders/aqnwb.git
* \endcode
*
* 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.
Expand Down Expand Up @@ -102,7 +107,7 @@
* cmake --build --preset=dev --target=<name of the target>
* \endcode
*
* \subsubsection devbuild_target_options_subsubsec Target options
* \subsection devbuild_target_options_subsubsec Target options
* - `format-check`: run the `clang-format` tool on the codebase to check for formatting errors
* - `format-fix` : run the `clang-format` tool on the codebase with `FIX=YES` to both check and automatically fix for formatting errors
* - `spell-check`: run the `codespell` tool on the codebase to check for common spelling errors
Expand Down
10 changes: 10 additions & 0 deletions docs/pages/userdocs/install.dox
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@
* - [HDF5 >= 1.10](https://github.com/HDFGroup/hdf5)
* - [Boost](https://www.boost.org/)
*
* \section userbuild_source_sec Source
*
* The source code for AqNWB is available online via the
* [AqNWB GitHub](https://github.com/NeurodataWithoutBorders/aqnwb) repository.
* To checkout the latest developer version, clone the repository via:
*
* \code{.sh}
* git clone https://github.com/NeurodataWithoutBorders/aqnwb.git
* \endcode
*
* \section userbuild_build_sec Build
*
* Here are the steps for building in release mode with a multi-configuration generator:
Expand Down
1 change: 1 addition & 0 deletions src/nwb/hdmf/table/DynamicTable.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class DynamicTable : public Container
* @param path The location of the table in the file.
* @param io A shared pointer to the IO object.
* @param description The description of the table (optional).
* @param colNames Names of the columns in the table
*/
DynamicTable(const std::string& path,
std::shared_ptr<BaseIO> io,
Expand Down

0 comments on commit 186f207

Please sign in to comment.