| @@ -1,21 +1,28 @@ |
| 1 | -# fluffy | 1 | +# fluffy - terminal game launcher |
| 2 | | 2 | |
| | 3 | +(only on linux) |
| 3 | | 4 | |
| 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. | 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 | | 6 | |
| 7 | ## Usage | 7 | ## Usage |
| 8 | | 8 | |
| | 9 | +### Command-line options |
| | 10 | + |
| 9 | - fluffy show - show list of games | 11 | - fluffy show - show list of games |
| | 12 | + |
| 10 | ```console | 13 | ```console |
| 11 | user:~/some/path$ fluffy show | 14 | user:~/some/path$ fluffy show |
| 12 | game_name: /path/to/your/game | 15 | game_name: /path/to/your/game |
| 13 | ``` | 16 | ``` |
| | 17 | + |
| 14 | - fluffy add <game_name> <game_path> - add a game | 18 | - fluffy add <game_name> <game_path> - add a game |
| | 19 | + |
| 15 | ```console | 20 | ```console |
| 16 | user:~/some/path$ fluffy add game_name path/to/your/game | 21 | user:~/some/path$ fluffy add game_name path/to/your/game |
| 17 | ``` | 22 | ``` |
| | 23 | + |
| 18 | - fluffy rm <game_name> - remove a game | 24 | - fluffy rm <game_name> - remove a game |
| | 25 | + |
| 19 | ```console | 26 | ```console |
| 20 | user:~/some/path$ fluffy rm game_name | 27 | user:~/some/path$ fluffy rm game_name |
| 21 | ``` | 28 | ``` |
| @@ -23,4 +30,6 @@ user:~/some/path$ fluffy rm game_name |
| 23 | - fluffy - runs a fluffy gui from which the game can be run | 30 | - fluffy - runs a fluffy gui from which the game can be run |
| 24 |  | 31 |  |
| 25 | | 32 | |
| 26 | -## Installation | | |
| \ No newline at end of file | | \ No newline at end of file |
| | 33 | +## Installation |
| | 34 | + |
| | 35 | +(work in progress) |