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

Flesh out README #2

Closed
wfvining opened this issue Feb 20, 2020 · 1 comment
Closed

Flesh out README #2

wfvining opened this issue Feb 20, 2020 · 1 comment

Comments

@wfvining
Copy link
Collaborator

Need to add a more detailed overview of the library to the README.

Should include at least some documentation of the dependencies and instructions for installing/building the library.
@wfvining wfvining mentioned this issue Feb 20, 2020
Closed
wfvining added a commit that referenced this issue Feb 20, 2020
@wfvining
Drafted initial library overview in README (#8)
2764b8f 
* Drafted initial library overview in README

Describes the strucures and some of the specific goals served by that
structure. Gives a starting point for discussions/planning in the
issues. Partly addresses #2.

* Rewording and edits suggested in review

Co-Authored-By: Cliff Hansen <cwhanse@sandia.gov>

* Re-fill paragraphs - makes README look nice when rendered as plain text.
@wfvining
Copy link
Collaborator Author

separated installation instructions as its own specific issue (#20)

@kperrynrel kperrynrel mentioned this issue Nov 6, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wfvining