search

bihealth / sodar-core-legacy

LEGACY repository for SODAR Core, preserved for saving review-related issues. See "sodar-core" for the up-to-date repository.
MIT License
15 stars 4 forks source link

Add installation instructions in README and docs #3

Closed olgabot closed 4 years ago

olgabot commented 5 years ago

Hello, Please add installation instructions using an automated package manager such as pip or conda to the README and documentation. Currently, the docs provide installation instructions only for apps within the project, and the project installation steps are in the "Development" section and require multiple manual steps.

RE https://github.com/openjournals/joss-reviews/issues/1584

Thank you! Warmest, Olga

rbatorsky commented 5 years ago

Hello, I'm also reviewing and was about to open a related issue so I will comment here instead. It appears that in order for the installation instructions to be complete, the instructions here https://github.com/bihealth/sodar_django_site should be included more prominently on the main site https://sodar-core.readthedocs.io/en/latest/.

I have successfully installed and connected to the server using these instructions for the example site. However, it was not straightforward to find.

Thank you, Rebecca

holtgrewe commented 5 years ago

Thanks for pointing this out. I guess this is one of the obvious things for a pair of "fresh" eyes to see while it's hard to find for the actual authors.

mikkonie commented 5 years ago

Just to confirm, I will also be working on this. Installing the package with. e.g. pip via pypi will be introduced shortly.

mikkonie commented 5 years ago

@olgabot and @rbatorsky: Apologies for the delay in reacting to this. In the currently pushed master branch, installation instructions have been added to both the README and the documentation. I hope this simplifies the issue.

holtgrewe commented 4 years ago

@olgabot @rbatorsky We added a link to the quickstart in the README.

I'm closing this ticket for now, please re-open in the case that you think we should address this in a different way.