diff --git a/README.md b/README.md index 79722e0..2a73947 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,39 @@ # PlaylistSaver -A tool to save your youtube playlist. **VERY UNSTABLE** +A tool to save your YouTube playlist. -## Development +## Run from source -Create a virtual environment and install the project with its build tools: - -```powershell -python -m venv .venv -.\.venv\Scripts\python.exe -m pip install -e ".[build]" +Sync project and install dependencies. +```bash +uv sync ``` Run from source: -```powershell -.\.venv\Scripts\playlist-saver.exe +```bash +python main.py ``` ## Build -Build the application with PyInstaller: +> [!IMPORTANT] +> This project does not support Nuitka for building. Some packages used in this project, such as mpv and yt-dlp, +> may not be able to function or may cause crashes in the building process. + +Install build tools: +```bash +uv pip install -e ".[build]" +``` + +Build this project with PyInstaller: ```powershell .\build.ps1 -Clean ``` -The application is written to `dist\PlaylistSaver`. The build includes only the +The build is written to `dist\PlaylistSaver`. This includes only the bundled mpv files matching the operating system and CPU architecture on which the build is performed. Build each target platform on that platform. + +## How to use \ No newline at end of file