bitwizeshift / bitwizeshift/Alloy

Document how to build this project

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

Description

I started this project _ages_ ago, but never documented how to configure it. Every now and then, I dust this project off and have to re-read my own CMake logic just to understand what I did. Ideally, this should be better documented in the `README.md`. Maybe even properly configured easily with some bash scripts.

There is a `how-to-build` file, but it's sorely outdated. This should be improved.

## Acceptance Criteria

* Setting up and building this project is properly documented / easy to follow

### Stretch Goal

* An easy-to-use bash script is added for configuring/building quickly

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.