DSiekmeier / DSiekmeier/booktrack-cli

Create architecture overview for developers

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
documentation internal
Dominant language
C++
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
To get started working on this project it would be a relief for developers to have a "big picture" of the software architecture. Although the source code is not that large at the moment, it will become more important later on.

**Describe the solution you'd like**
It should be possible to draw some charts using [Mermaid](https://mermaid-js.github.io) in the repository markdown files. It might be useful to add a `DEVELOPER.md`.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.