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.

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

Add pre-reqs section to README #306

Open
korikuzma opened this issue Aug 7, 2024 · 0 comments
Open

Add pre-reqs section to README #306

korikuzma opened this issue Aug 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation priority:low Low priority

Comments

@korikuzma
Copy link
Member

Feature description

It would be nice to have a per-requisites section, similar to VRS-Python, of what is needed to be installed separately in order to get the app running locally

Use case

As a user, it would be nice to know what I need to install locally ahead of time without running into issues as I'm trying to install / start the app locally

Proposed solution

No response

Alternatives considered

No response

Implementation details

Not sure if this is part of #215

Potential Impact

Less headaches for users trying to install locally!

Additional context

For example, virtualenv is not installed automatically with Python. I recommend either adding a step to install or using the built in venv module

Contribution

None

@korikuzma korikuzma added documentation Improvements or additions to documentation enhancement New feature or request priority:low Low priority and removed enhancement New feature or request labels Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority:low Low priority
Projects
None yet
Development

No branches or pull requests

1 participant