mirror of
https://github.com/nathom/streamrip.git
synced 2025-05-17 16:45:13 -04:00
update README
This commit is contained in:
parent
f0850b989f
commit
0420e94a1c
1 changed files with 28 additions and 21 deletions
49
README.md
49
README.md
|
@ -125,31 +125,27 @@ rip discover --list 'best-sellers'
|
|||
|
||||
## Troubleshooting
|
||||
|
||||
First, consult the help pages and their example commands.
|
||||
If you're having issues with the tool, try the following:
|
||||
|
||||
```bash
|
||||
rip --help
|
||||
```
|
||||
- Consult the help pages and their example commands.
|
||||
```bash
|
||||
rip --help
|
||||
|
||||
```bash
|
||||
rip filter --help
|
||||
```
|
||||
rip filter --help
|
||||
|
||||
```bash
|
||||
rip search --help
|
||||
```
|
||||
rip search --help
|
||||
|
||||
```bash
|
||||
rip discover --help
|
||||
```
|
||||
rip discover --help
|
||||
|
||||
```bash
|
||||
rip config --help
|
||||
```
|
||||
rip config --help
|
||||
|
||||
rip lastfm --help
|
||||
```
|
||||
- Update `streamrip` with by running `pip3 install streamrip --upgrade`
|
||||
- Reset the config file with `rip config --reset`
|
||||
|
||||
If none of the above work, open an [issue](###guidelines-for-opening-issues)
|
||||
|
||||
```bash
|
||||
rip lastfm --help
|
||||
```
|
||||
|
||||
Second, try resetting the config file with `rip config —reset`. Config errors often arise after an update where a new feature was added.
|
||||
|
||||
|
@ -161,7 +157,19 @@ If that doesn't work, open an issue on GitHub. Please include the traceback and
|
|||
|
||||
## Contributions
|
||||
|
||||
All contributions are appreciated! If you're new to Git, follow these steps to open your first Pull Request (PR):
|
||||
All contributions are appreciated! You can help out the project by opening an issue
|
||||
or by submitting code.
|
||||
|
||||
### Guidelines for opening issues
|
||||
|
||||
- Include a general description of the feature request or bug in the title
|
||||
- Limit each Issue to a single subject
|
||||
- For bug reports, include the command (including the url) you used and version of `streamrip`
|
||||
-
|
||||
|
||||
### Contributing code
|
||||
|
||||
If you're new to Git, follow these steps to open your first Pull Request (PR):
|
||||
|
||||
- Fork this repository
|
||||
- Clone the new repository
|
||||
|
@ -171,7 +179,6 @@ All contributions are appreciated! If you're new to Git, follow these steps to o
|
|||
Please document any functions or obscure lines of code.
|
||||
|
||||
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Thanks to Vitiko98, Sorrow446, and DashLt for their contributions to this project, and the previous projects that made this one possible.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue