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 for non-git users #4

Closed
smnnlt opened this issue Apr 28, 2023 · 1 comment
Closed

Installation instructions for non-git users #4

smnnlt opened this issue Apr 28, 2023 · 1 comment

Comments

@smnnlt
Copy link

smnnlt commented Apr 28, 2023

The aim of your software with the GUI-interface is to reach a wide audience including non-programmers. Currently the README only provides installation instruction using git. To enable users not using git to use your software I recommend to include a comment on how to install the software without using git. This may be as simple as pointing out to the "Download Zip" option on Github.

Issue during review for the JOSS (openjournals/joss-reviews#5391).
charlienew added a commit that referenced this issue May 10, 2023
@charlienew
Feature and README Update
4376898 
Feature update:

Patient ID will no longer include file extensions by default. (See issue #5)

README updates:

1. Added instructions of download for non-git users. (See issue #4)

2. Added contribution guidelines and support instructions. (See issue #3)
@charlienew
Copy link
Collaborator

Thanks @smnnlt for your suggestion. We added additional instructions in README about how to download our software directly from GitHub. Moreover, we also plan to release a compiled version of HRnV-Calc for people without Matlab installation in the future.

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
@charlienew @smnnlt