Update README.md Quickstart #305
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: ChristophorusReyhan <39609246+ChristophorusReyhan@users.noreply.github.com>
bytequill
reviewed
Jul 30, 2025
bytequill
left a comment
bytequill
left a comment
There was a problem hiding this comment.
Just a bit of minor feedback (mostly just pet-peeves) from a random person, no idea why I decided to randomly review a doc PR
| python copyparty-sfx.py -c config.conf | ||
| ``` | ||
|
|
||
| **4. Install Extras (Optional)** |
There was a problem hiding this comment.
consider rewording Extras into extra/optional dependencies
| * ...maybe [prisonparty](./bin/prisonparty.sh) to create a tiny [chroot](https://wiki.archlinux.org/title/Chroot) (very portable), | ||
| * ...or [bubbleparty](./bin/bubbleparty.sh) to wrap it in [bubblewrap](https://github.com/containers/bubblewrap) (much better) | ||
| * or if you prefer to [use docker](./scripts/docker/) 🐋 you can do that too | ||
| * docker has all deps built-in, so skip this step: |
There was a problem hiding this comment.
The config-file install header breaks the flow of this line into the #Thumbnail instructions. Consider rewording and/or adding a link to the section?
eg.
Suggested change
| * docker has all deps built-in, so skip this step: | |
| * docker has all deps built-in, so, skip the [Thumbnails](#thumbnails) step |
|
|
||
| Ubuntu/Debian: `sudo apt install python3-pil ffmpeg` | ||
|
|
||
| Windows: `pip install --user Pillow` + add FFmpeg to PATH |
There was a problem hiding this comment.
- add the
--no-install-recommendsto theaptexample (as seen on L220) - While I understand including install instructions for most used OSes it would probably be better to just link to the section because this way you include all the additional Windows information, basic documentation on media tags
|
|
||
| Windows: `pip install --user Pillow` + add FFmpeg to PATH | ||
|
|
||
| **5. Expose Publicly (Optional)** |
There was a problem hiding this comment.
There are a lot of ways to expose a web service on the open internet. Cloudflare tunnel is a good way to securely expose ad-hoc but I'm not sure we want to specifically feature that in a quickstart
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
quickstart for users who want to use config file instead