Skip to content

Commit

Permalink
docs: Add skeletal developer document
Browse files Browse the repository at this point in the history
Signed-off-by: James O. D. Hunt <[email protected]>
  • Loading branch information
jamesodhunt committed Nov 24, 2024
1 parent b83235d commit 6e8146b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README-DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# procenv developer details

> **Note:**
>
> This document assumes you have already read the
> [build document](README-BUILD.md).
## Debug with gdb or lldb

To disable optimisations when building `procenv`, configure by specifying
the `--disable-compiler-optimisations` configure option (which sets the
`-O0` compiler option):

```bash
$ /configure --disable-compiler-optimisations
$ make
$ gdb src/procenv
```
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ applications.
For instructions on building from source, see also the
[build document](README-BUILD.md).

## Developer documentation

See the [developer document](README-DEVELOPER.md).

## Install

### Snap
Expand Down

0 comments on commit 6e8146b

Please sign in to comment.