diff --git a/README.md b/README.md index 595889480..69d8d1b5b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management. -# Want to Contribute? 😄 +# Want to Contribute?     @@ -62,4 +62,20 @@ Handles file system operations and provides a secure bridge between the frontend --- -Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) +## Installation + +To run the app locally: + +1. Install all dependencies (Backend, Docs, and Microservices): + ```bash + pip install -r requirements.txt + ``` + +2. Serve the documentation: + ```bash + mkdocs serve + ``` + +3. Open your browser and navigate to `http://127.0.0.1:8000`. + +Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..f7303cb48 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +-r backend/requirements.txt +-r docs/requirements.txt +-r sync-microservice/requirements.txt