From c7bddeabeba108a603317961ef00e87898e3b81c Mon Sep 17 00:00:00 2001 From: bacalhau Date: Wed, 4 Mar 2026 18:59:44 +0000 Subject: [PATCH] updated readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 736b075..d596580 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,17 @@ This website also does not use JavaScript making it easy to run on any browser. ## 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. + +## 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`