Documentation: Update README (12.11.2024)

[Gero1999]

Issue

Closes #110

Description

Current README in the main branch is outdated, does not contain all required information and even has some incorrect statements. Should me updated to the current state of the package.

Definition of Done

Update all relevant content

How to test

• Installation guidelines work well
• Content information is updated and accurate

Feel free to modify or add content as well!

Contributor checklist

• Code passes lintr checks
• Code passes all unit tests
• New logic covered by unit tests
• New logic is documented

[js3110]

LGTM

[m-kolomanski]

Hi, from my side:

• 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
• I have updated the badges, as the links pointed towards shiny repository, not aNCA
• I have updated links to contributing guidelines
• 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.

In addition, I have some comments and requested changes. The contents seem to be copied over from a template, please make sure only applicable parts are included and that the links point in the right directions.

[Gero1999]

Hi, from my side:

• 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
• I have updated the badges, as the links pointed towards shiny repository, not aNCA
• I have updated links to contributing guidelines
• 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.

In addition, I have some comments and requested changes. The contents seem to be copied over from a template, please make sure only applicable parts are included and that the links point in the right directions.

Hello Mateusz! You are right, our main branch has commented code that I was not sure if to keep it perhaps for the future, but I just deleted it and solve the issues you mentioned. I will test with some others non-programming based people to check if they manage to understand completely the instructions on their own, as I know that sometimes this can be a game changer for our users.

And many thanks for making the changes, I think now it looks much better! 😎

[Gotfrid]

README looks good to me, but regarding the installation - I believe that we should strive to providing ability to run the app via package installation. I tried to quickly check it, and I uncovered a few issues that I could address and make it happen.

@m-kolomanski so in the current state I do agree with you: it's hard to run the app via installing the package, but I suggest that I create a separate issue and work on bringing that ability to the project.

[m-kolomanski]

I agree with @Gotfrid , changing how the package loads dependencies is out of scope of this issue and that is why I have suggested removing the information altogether. Lets create a separate issue as @Gotfrid suggests, and then update README alongside when that option is available.