Skip to content

Commit

Permalink
Markdown tweaks to dev-guide (jbcoe#277)
Browse files Browse the repository at this point in the history
Co-authored-by: Antony Peacock <ant.peacock@gmail.com>
  • Loading branch information
jbcoe and Twon authored Nov 20, 2023
1 parent a7e60e2 commit d71534e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Using pre-commit for git hooks
# Developer Guide

## Using pre-commit for git hooks

This repository uses the Python `pre-commit` library to manage git hook run as
part of the commit process. Use the following steps to install a virtual
Expand All @@ -13,7 +15,7 @@ pip install -r requirements.txt # Install latest requirements including pre-comm
pre-commit install # Use pre-commit to install git hooks into the working repository.
```

# Building with CMake
## Building with CMake

To build the repository with CMake use the following steps
```bash
Expand All @@ -24,7 +26,7 @@ cmake ../ # Generate build system specified in root with cmake
cmake --build ./ # Build the underlying build system via CMake
```

# Including in your own project
## Including value_types your own project

To use the value types code in your own CMake project then you can pull
the project in as a dependency via CMake's FetchContent module as follows:
Expand All @@ -43,7 +45,7 @@ target_link_libraries(my_program
)
```

# Contributing
## Contributing

We use GitHub actions to ensure that all changes have test coverage and that
source code is formatted with clang-format (v17).
Expand Down

0 comments on commit d71534e

Please sign in to comment.