updated readme

This commit is contained in:
bacalhau 2026-03-04 18:59:44 +00:00
parent 2b835d7500
commit c7bddeabeb

View file

@ -16,3 +16,17 @@ This website also does not use JavaScript making it easy to run on any browser.
## Contributing ## Contributing
If you have suggestions, find bugs, or want to provide code, just open an issue before submiting a PR. I will probably not accept a PR unless I see that it's actually somewhat important, exceptions can be made, but its kinda goofy to write the code before submiting an issue. If you have suggestions, find bugs, or want to provide code, just open an issue before submiting a PR. I will probably not accept a PR unless I see that it's actually somewhat important, exceptions can be made, but its kinda goofy to write the code before submiting an issue.
## Running the program
#### Docker/Podman
`docker compose up -d`
`podman-compose up -d`
### python enviornment
`python -m venv venv`
### Install the dependencies
`pip install -r requirements.txxt`
### Run the program
`pyhton src/main.py`