Documentation: Update README (12.11.2024) #115
Merged
Task list completed / task-list-completed
succeeded
Nov 15, 2024 in 0s
6 / 6 tasks completed
All tasks have been completed
Details
Required Tasks
| Task | Status |
|---|---|
| Installation guidelines work well | Completed |
| Content information is updated and accurate | Completed |
| Code passes lintr checks | Completed |
| Code passes all unit tests | Completed |
| New logic covered by unit tests | Completed |
| New logic is documented | Completed |
| I do not think it is currently useful to install the package directly from github. We cannot run the application like that since the dependencies will not load, we will need to fix that. So after installation, you still have to change the directory to the installation directory, which makes more sense when the repo is cloned directly - I have left only this part in, as I think it makes the most sense | Incomplete |
I have updated the badges, as the links pointed towards shiny repository, not aNCA |
Incomplete |
| I have updated links to contributing guidelines | Incomplete |
| I have added a *Quick start - so the basics of app usage and what the user can do to test it out upon first startup. Please read and verify that it is correct, maybe some other workflow makes more sense - then please change. | Incomplete |
| I do not think it is currently useful to install the package directly from github. We cannot run the application like that since the dependencies will not load, we will need to fix that. So after installation, you still have to change the directory to the installation directory, which makes more sense when the repo is cloned directly - I have left only this part in, as I think it makes the most sense | Incomplete |
I have updated the badges, as the links pointed towards shiny repository, not aNCA |
Incomplete |
| I have updated links to contributing guidelines | Incomplete |
| I have added a *Quick start - so the basics of app usage and what the user can do to test it out upon first startup. Please read and verify that it is correct, maybe some other workflow makes more sense - then please change. | Incomplete |
Loading