updated readme
2a77c1c parent: dda4a51 modified
README.md +26 -1 | @@ -1 +1,26 @@ | ||
| 1 | -# fluffy | |
| \ No newline at end of file | ||
| 1 | +# fluffy | |
| 2 | + | |
| 3 | + | |
| 4 | +## Terminal Game Launcher | |
| 5 | +Fluffy's goal is to provide simple and fast possibility to run games from user defined directories and store all the required paths in one place. | |
| 6 | + | |
| 7 | +## Usage | |
| 8 | + | |
| 9 | +- fluffy show - show list of games | |
| 10 | +```console | |
| 11 | +user:~/some/path$ fluffy show | |
| 12 | +game_name: /path/to/your/game | |
| 13 | +``` | |
| 14 | +- fluffy add <game_name> <game_path> - add a game | |
| 15 | +```console | |
| 16 | +user:~/some/path$ fluffy add game_name path/to/your/game | |
| 17 | +``` | |
| 18 | +- fluffy rm <game_name> - remove a game | |
| 19 | +```console | |
| 20 | +user:~/some/path$ fluffy rm game_name | |
| 21 | +``` | |
| 22 | + | |
| 23 | +- fluffy - runs a fluffy gui from which the game can be run | |
| 24 | + | |
| 25 | + | |
| 26 | +## Installation | |
| \ No newline at end of file | ||
| @@ -1 +1,26 @@ | |||
| 1 | -# fluffy | ||
| \ No newline at end of file | \ No newline at end of file | ||
| 1 | +# fluffy | ||
| 2 | + | ||
| 3 | + | ||
| 4 | +## Terminal Game Launcher | ||
| 5 | +Fluffy's goal is to provide simple and fast possibility to run games from user defined directories and store all the required paths in one place. | ||
| 6 | + | ||
| 7 | +## Usage | ||
| 8 | + | ||
| 9 | +- fluffy show - show list of games | ||
| 10 | +```console | ||
| 11 | +user:~/some/path$ fluffy show | ||
| 12 | +game_name: /path/to/your/game | ||
| 13 | +``` | ||
| 14 | +- fluffy add <game_name> <game_path> - add a game | ||
| 15 | +```console | ||
| 16 | +user:~/some/path$ fluffy add game_name path/to/your/game | ||
| 17 | +``` | ||
| 18 | +- fluffy rm <game_name> - remove a game | ||
| 19 | +```console | ||
| 20 | +user:~/some/path$ fluffy rm game_name | ||
| 21 | +``` | ||
| 22 | + | ||
| 23 | +- fluffy - runs a fluffy gui from which the game can be run | ||
| 24 | + | ||
| 25 | + | ||
| 26 | +## Installation | ||
| \ No newline at end of file | \ No newline at end of file | ||
added
screenshots/fluffy_0_1.png +0 -0 | new file mode 100644 | ||
| Binary files /dev/null and b/screenshots/fluffy_0_1.png differ | ||
| new file mode 100644 | |||
| Binary files /dev/null and b/screenshots/fluffy_0_1.png differ | Binary files /dev/null and b/screenshots/fluffy_0_1.png differ | ||