Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #3

Open
aidanheerdegen opened this issue Aug 23, 2024 · 1 comment
Open

Update README #3

aidanheerdegen opened this issue Aug 23, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation priority:high

Comments

@aidanheerdegen
Copy link
Member

README needs to be updated to explain the purpose of this repository.

Should also include the requirements in order to compile/develop the code, as it requires being added to some private repos.

@aidanheerdegen aidanheerdegen added documentation Improvements or additions to documentation priority:high labels Aug 23, 2024
@dougiesquire
Copy link
Contributor

dougiesquire commented Aug 23, 2024

Note, there is an update to the README included in #2. But it doesn't yet include all of this info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority:high
Projects
None yet
Development

No branches or pull requests

2 participants