Horizontal42/Sort_YM
1
0
Fork 0
mirror of https://github.com/Horizontal42/Sort_YM.git synced 2026-11-10 19:11:59 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

cross-platform command variants in README (windows/linux/macos)

Browse source
This commit is contained in:
Andrew Pimenov 2026-08-16 19:58:17 +03:00
parent 9ed1239385
commit 42bbd924cc
2 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -22,15 +22,19 @@ Requirements: Python 3.11+ (uses `tomllib` from the standard library), Windows/L
``` ```
python -m venv .venv python -m venv .venv
.venv\Scripts\pip install -r requirements.txt .venv\Scripts\pip install -r requirements.txt # Windows
.venv/bin/pip install -r requirements.txt # Linux/macOS
``` ```
For development (tests): For development (tests):
``` ```
.venv\Scripts\pip install -r requirements-dev.txt .venv\Scripts\pip install -r requirements-dev.txt # Windows
.venv/bin/pip install -r requirements-dev.txt # Linux/macOS
``` ```
All commands below use the Windows `.venv\Scripts\...` path — on Linux/macOS substitute `.venv/bin/...`.
## What it does ## What it does
### Core commands ### Core commands
@ -77,7 +81,8 @@ These flags change that — from most to least commonly useful:
To start over from scratch (re-fetch everything), delete the `cache/` folder: To start over from scratch (re-fetch everything), delete the `cache/` folder:
``` ```
Remove-Item -Recurse -Force cache Remove-Item -Recurse -Force cache # Windows (PowerShell)
rm -rf cache # Linux/macOS
``` ```
The cache consists of four files: The cache consists of four files:
@ -91,7 +96,8 @@ Deleting `cache/` makes `fetch` and `report` re-fetch everything from scratch on
You can also delete the generated reports (`out/report.csv`, `out/digest.md`): You can also delete the generated reports (`out/report.csv`, `out/digest.md`):
``` ```
Remove-Item -Recurse -Force out Remove-Item -Recurse -Force out # Windows (PowerShell)
rm -rf out # Linux/macOS
``` ```
It's just analysis output — deleting it doesn't affect the next `report`/`digest` run. It's just analysis output — deleting it doesn't affect the next `report`/`digest` run.
@ -99,7 +105,8 @@ It's just analysis output — deleting it doesn't affect the next `report`/`dige
**Important:** the `.token` file (OAuth token) is not part of the cache and is not removed by clearing `cache/`. Clearing the cache does not log you out. To force re-authentication, delete `.token` separately: **Important:** the `.token` file (OAuth token) is not part of the cache and is not removed by clearing `cache/`. Clearing the cache does not log you out. To force re-authentication, delete `.token` separately:
``` ```
Remove-Item .token Remove-Item .token # Windows (PowerShell)
rm .token # Linux/macOS
``` ```
## How genre and language are determined ## How genre and language are determined

17
README.ru.md
View file

@ -22,15 +22,19 @@ $ python -m sort_ym report
``` ```
python -m venv .venv python -m venv .venv
.venv\Scripts\pip install -r requirements.txt .venv\Scripts\pip install -r requirements.txt # Windows
.venv/bin/pip install -r requirements.txt # Linux/macOS
``` ```
Для разработки (тесты): Для разработки (тесты):
``` ```
.venv\Scripts\pip install -r requirements-dev.txt .venv\Scripts\pip install -r requirements-dev.txt # Windows
.venv/bin/pip install -r requirements-dev.txt # Linux/macOS
``` ```
Все команды ниже используют путь Windows `.venv\Scripts\...` — на Linux/macOS вместо него `.venv/bin/...`.
## Что делает ## Что делает
### Основные команды ### Основные команды
@ -77,7 +81,8 @@ python -m venv .venv
Если требуется начать с чистого листа (переполучить все данные с нуля), удалите папку `cache/`: Если требуется начать с чистого листа (переполучить все данные с нуля), удалите папку `cache/`:
``` ```
Remove-Item -Recurse -Force cache Remove-Item -Recurse -Force cache # Windows (PowerShell)
rm -rf cache # Linux/macOS
``` ```
Кэш состоит из четырёх файлов: Кэш состоит из четырёх файлов:
@ -91,7 +96,8 @@ Remove-Item -Recurse -Force cache
Также можно удалить сгенерированные отчёты (`out/report.csv`, `out/digest.md`): Также можно удалить сгенерированные отчёты (`out/report.csv`, `out/digest.md`):
``` ```
Remove-Item -Recurse -Force out Remove-Item -Recurse -Force out # Windows (PowerShell)
rm -rf out # Linux/macOS
``` ```
Это просто результаты анализа, их удаление не повлияет на следующий запуск `report`/`digest`. Это просто результаты анализа, их удаление не повлияет на следующий запуск `report`/`digest`.
@ -99,7 +105,8 @@ Remove-Item -Recurse -Force out
**Важно:** файл `.token` (OAuth-токен) не входит в кэш и не удаляется при очистке `cache/`. Очистка кэша вас не разлогирует. Если нужна повторная авторизация, удалите `.token` отдельно: **Важно:** файл `.token` (OAuth-токен) не входит в кэш и не удаляется при очистке `cache/`. Очистка кэша вас не разлогирует. Если нужна повторная авторизация, удалите `.token` отдельно:
``` ```
Remove-Item .token Remove-Item .token # Windows (PowerShell)
rm .token # Linux/macOS
``` ```
## Как определяется жанр и язык ## Как определяется жанр и язык