Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Supergamer1337 committed Apr 26, 2023
1 parent 4899ff6 commit 8974277
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ Once you have your config file, you can run the program with `./media-cleaner` (

### Arguments

Arguments are used to either:

1. Speed up the process by skipping certain screens.
2. Change the behavior of the program.

#### Sorting

You can also pass an argument to the program to skip the sorting screen and go straight to the requests screen. The argument is the sorting method you want to use, and can be one of the following:

- `-s`: Sort by size
Expand All @@ -58,6 +65,10 @@ You can also pass an argument to the program to skip the sorting screen and go s
- `-nd`: Sort by name, in descending order
- `-t`: Sort by media type

#### Getting a list of all media

By passing in the flag `-C`, the program will instead show a list of all media in your library, with the same information as the requests screen. This is useful if you want to see what media you have in your library, and what you can remove. Even though that item does not have a request associated with it. Otherwise it works the same as the "normal" requests screen.

## Issues and PRs

You are welcome to open issues, but please be aware that this is a hobby project written to help me learn Rust, and as such have no ambitions to a) implement features I don't want (though you are free to open a PR and I'll have a look at it), and b) fix issues that don't plague me personally (unless I feel it is large enough to warrant a fix).
Expand Down

0 comments on commit 8974277

Please sign in to comment.