refactor: add hacking at the bottom
This commit is contained in:
40
README.md
40
README.md
@@ -12,26 +12,6 @@ Python 3.13+.
|
|||||||
|
|
||||||
The rest of the dependencies are listed in [pyproject.toml](pyproject.toml).
|
The rest of the dependencies are listed in [pyproject.toml](pyproject.toml).
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
You can use `uv` to install dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://git.kharec.info/Kharec/skywipe.git
|
|
||||||
cd skywipe
|
|
||||||
uv sync
|
|
||||||
```
|
|
||||||
|
|
||||||
Then start coding.
|
|
||||||
|
|
||||||
If you want to test your changes, you can run the tool with:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
uv run python -m skywipe.cli -h
|
|
||||||
uv run python -m skywipe.cli all
|
|
||||||
# or any other command
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Use [`pipx`](https://pipx.pypa.io/latest/installation/) to install `skywipe`:
|
Use [`pipx`](https://pipx.pypa.io/latest/installation/) to install `skywipe`:
|
||||||
@@ -62,6 +42,26 @@ verbose: true
|
|||||||
|
|
||||||
BE SURE TO USE A [BLUESKY APP PASSWORD](https://blueskyfeeds.com/faq-app-password) FOR OBVIOUS SECURITY REASONS.
|
BE SURE TO USE A [BLUESKY APP PASSWORD](https://blueskyfeeds.com/faq-app-password) FOR OBVIOUS SECURITY REASONS.
|
||||||
|
|
||||||
|
## Hacking
|
||||||
|
|
||||||
|
You can use `uv` to install dependencies:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.kharec.info/Kharec/skywipe.git
|
||||||
|
cd skywipe
|
||||||
|
uv sync
|
||||||
|
```
|
||||||
|
|
||||||
|
Then start coding.
|
||||||
|
|
||||||
|
If you want to test your changes, you can run the tool with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run python -m skywipe.cli -h
|
||||||
|
uv run python -m skywipe.cli all
|
||||||
|
# or any other command
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the GPLv3+ License. See the [LICENSE](LICENSE) file for details.
|
This project is licensed under the GPLv3+ License. See the [LICENSE](LICENSE) file for details.
|
||||||
|
|||||||
Reference in New Issue
Block a user