Craig Oates
5 years ago
4 changed files with 77 additions and 3 deletions
@ -0,0 +1,72 @@
|
||||
Here is a list of the available commands in DeathSocketCLI. Each |
||||
command uses the following template; |
||||
|
||||
## Name |
||||
|
||||
- Parameters |
||||
- Description |
||||
- Usage Example(s) |
||||
|
||||
## `test` |
||||
|
||||
- N.A. |
||||
- Display a text message indicating this program is running properly. |
||||
- `test` |
||||
|
||||
## `help` |
||||
|
||||
- N.A. |
||||
- Displays a list of available commands provided by this program. |
||||
- `help` |
||||
|
||||
## `exit` |
||||
|
||||
- N.A. |
||||
- Exits the program. |
||||
- `exit` |
||||
|
||||
## `add-default` |
||||
|
||||
- `(image-path: string)` `(new-path: string)` |
||||
- Takes the image at `image-path` applies a 10x10 grid (in white) to |
||||
it and saves the result at `new-path`. |
||||
- `add-default C:/my-images/test-image-1.png |
||||
C:/converted-images/converted-test.png` |
||||
- `add-default "C:/path with spaces in needs double-quotes/Image1.png" |
||||
C:/images/converted-test.jpg` |
||||
|
||||
## `add-grid` |
||||
|
||||
- `(image-path: string) (no-of-rows: int) (no-of-columns: int) |
||||
(pen-width: float32) (colour: string) (new-path: string)` |
||||
- Adds a grid to an image, using the specified parameters, and saves |
||||
it. |
||||
- `add-grid "C:/path with spaces in needs double-quotes/Image1.png" 10 |
||||
5 2 red C:/new-image.png` |
||||
- `add-grid C:/orignal-image.png 16 3 12 red C:/new-image.png` |
||||
|
||||
## List Colours |
||||
|
||||
- N.A. |
||||
- Lists out the colours this program uses to draw its grids. |
||||
- `list-colours` |
||||
|
||||
---------------------------------------------------------------------- |
||||
|
||||
## List of Available Colours |
||||
|
||||
DeathSocketCLI uses a handful of colours in an attempt to keep things |
||||
simple for the end-user. My thinking around this is it is easier to |
||||
remember something like "red" than "#ef23ed". So, here are the list of |
||||
colours you can use in DeathSocketCLI; |
||||
|
||||
- blue |
||||
- brown |
||||
- black |
||||
- gray |
||||
- grey |
||||
- green |
||||
- purple |
||||
- red |
||||
- white |
||||
- yellow |
Loading…
Reference in new issue