diff --git a/README.md b/README.md index bd21a76..26477d5 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,31 @@ A simple, motivating training diary focused on Calisthenics and basic health met - **Progress Tracking:** Visual graphs for weight and waist trends. - **Motivation:** Streak tracking to keep you consistent. -## How to Run -1. Ensure you have Python 3.10+ installed. -2. The dependencies are already installed in the `venv` folder if you used the setup script. -3. Run the application: - ```bash - ./venv/bin/python main.py - ``` +## Installation + +1. **Clone the repository:** + ```bash + git clone https://gitea.ramforth.net/ramforth/ExerciseDiary.git + cd ExerciseDiary + ``` + +2. **Create a virtual environment (recommended):** + ```bash + python3 -m venv venv + source venv/bin/activate # On Windows use: venv\Scripts\activate + ``` + +3. **Install dependencies:** + ```bash + pip install -r requirements.txt + ``` + +## Running the App + +Run the application using the python executable from your virtual environment: +```bash +python main.py +``` ## Tech Stack - **GUI:** CustomTkinter diff --git a/requirements.txt b/requirements.txt index d54d2d1..c9d2bff 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ customtkinter matplotlib packaging pillow +numpy \ No newline at end of file