Firq/skyeweave
Firq/skyeweave
1
0
Fork 0
Code Issues Pull requests Releases15 Packages1 Activity Actions

Updated readme, fixed linting and type annotations

Browse source
This commit is contained in:
Firq 2025-04-04 11:33:49 +02:00
parent acc05a99bb
commit b701a91083
Signed by: Firq
GPG key ID: 3ACC61C8CEC83C20
12 changed files with 84 additions and 33 deletions

44
README.md
View file

@ -60,10 +60,48 @@ If there are any issues with `skyeweave`, feel free to reach out to me using the
If you want to help me debug when an issue occurs, set the environment variable `SKYEWEAVE_STDOUT_LEVEL` to `debug` and send me a copy of the log
Example on Windows:
Windows (PowerShell):
```shell
```powershell
$env:SKYEWEAVE_STDOUT_LEVEL="debug"
skyeweave --output out --id 70 > log.log
skyeweave --output out --id 70 2>&1 log.log
```
Linux (Bash):
```bash
SKYEWEAVE_STDOUT_LEVEL="debug"
skyeweave --output out --id 70 2>&1 log.log
```
## Contributing
Feel free to reach out if you want to help to improve skyeweave. I really appreachiate it.
## FAQ
> Q: Why Python
A: Because it is the language I am the most familiar with, and I know my stuff. I also like not having to deal with too many restrictions when developing or the mess that is JS/TS.
> Q: Why a CLI script?
A: Because it felt like the appropriate solution for this problem. Writing a whole GUI application felt overkill, and for the most part having the tool just spittingt out the necessary files is more than enough.
> Q: Where is the executable? Why do I have to install Python?
A: ~~Because I said so!~~ In all honesty, I felt that it's too much work for too little return building executables for multiple systems, expecially with `pyinstaller` resulting in a large executable for what is actually happening. Installing Python is pretty straightforward, and I have attached guidance for setting up from scratch below. Also: See [this gem](https://www.reddit.com/r/github/comments/1at9br4) for another reason.
> Q: How did this come to be?
A: I am usually editing thumbnails for my videos with the expression sheets, and at some point I was just annoyed as the process of editing those for EVERY. SINGLE. SERVANT. IN. EVERY. THUMBNAIL.
## How to install Python?
1. Go to [the download page](https://www.python.org/downloads/) and download a current version of Python (must be version 3.10 or later for this package to work).
2. Install Python as you would any other program, make sure it gets added to PATH
3. Open a Terminal (cmd, poweshell on Windows; bash, sh, ... on Linux) and run `python --version` once to verify it installed correctly. There should be some output like `Python 3.11.9`
After this, you can continue with the instructions above. I highly recommend you check out of virtual environments (venv) work beofre installing, so that you don't pollute the global package installation directory.