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

Installation instructions missing #1

Closed
jkmacc-LANL opened this issue Sep 13, 2021 · 3 comments
Closed

Installation instructions missing #1

jkmacc-LANL opened this issue Sep 13, 2021 · 3 comments

Comments

@jkmacc-LANL
Copy link

jkmacc-LANL commented Sep 13, 2021 •
edited
Loading

Hello! While there is an Downloading and installing section in your project's README, there appear to be no instructions to download or install the software. Many users will certainly be familiar with Makefiles and compiling C code, but some may not. In your README, could you please provide a few sentences of instruction or CLI commands, as well as any pre-installation requirements?

Thank you for your efforts on this library!

EDIT: cross-link to openjournals/joss-reviews#3619
@jkmacc-LANL jkmacc-LANL mentioned this issue Sep 13, 2021
Closed
60 tasks
savage13 added a commit that referenced this issue Sep 13, 2021
@savage13
Added documentation for compiling and installation
9cd687b 
Fixes to #1 with instructions for downloading, compiling and installation.
savage13 added a commit that referenced this issue Sep 13, 2021
@savage13
Add language about dependencies
b9d23fc 
Link to #1
@savage13
Copy link
Owner

Let me know if the instructions are make sense.

@jkmacc-LANL
Copy link
Author

This is fantastic. Thank you.

@savage13
Copy link
Owner

Closing

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
2 participants
@savage13 @jkmacc-LANL