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.

Sign up for GitHub

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

Jump to bottom

Documentation missing #9

Open
nedtaylor opened this issue Oct 27, 2023 · 5 comments
Open

Documentation missing #9

nedtaylor opened this issue Oct 27, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@nedtaylor
Copy link
Contributor

There is currently a lack of documentation with this project.

Most importantly, a README should be properly set up for the project. Detail the purpose of the project, what the files are, how the package is compiled, what compilers and architectures has this package been tested/built on, who are the contributors?

A wiki should be developed later on to describe the different modules and procedures available within the code. A how-to guide should also be detailed in the wiki.
@nedtaylor
Copy link
Contributor Author

added #10 as child task

@nedtaylor
Copy link
Contributor Author

added #11 as child task

@nedtaylor
Copy link
Contributor Author

added #12 as child task

@nedtaylor
Copy link
Contributor Author

added #13 as child task

@nedtaylor
Copy link
Contributor Author

added #14 as child task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nedtaylor