create Console API page.

master
Craig Oates 5 years ago
parent
commit
d7b31f3ea1
  1. 6
      CLI-Aliases.md
  2. 72
      Console-API.md
  3. 1
      Home.md
  4. 1
      _sidebar.md

6
CLI-Aliases.md

@ -3,7 +3,7 @@ you are new to the program, I recommend you stick to the verbose
commands for now. When you are familiar with them, feel free to
return here. You can view the verbose commands using the following link;
- [Console Program A.P.I](Console-Program-API)
- [Console Program A.P.I.](Console-Program-API)
The aliases in this console program have limitations when compared to
PowerShell or Bash. This is because the aliases are hard-coded. You
@ -20,8 +20,8 @@ aliases make little sense.
Alias commands are not displayed in the console's "help" section or
cheat sheet because I want to avoid confusion. It is not my intention
to make first-time users feel like they have two sets of commands
they need to learn. Thus, **here is the only place these aliases are
documented**, apart from the actual source code.
they need to learn. Thus, here is the only place these aliases are
documented, apart from the actual source code.
|Original Command|Alias|
|----------------|:---:|

72
Console-API.md

@ -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

1
Home.md

@ -56,6 +56,7 @@ Before continuing, I recommend you are familiar with the following;
- [C.L.I. Home](CLI-Home)
- [Using the Console Program](Using-the-Console-Program)
- [Console A.P.I.](Console-API)
- [C.L.I. Aliases](CLI-Aliases)
### As a NuGet

1
_sidebar.md

@ -13,6 +13,7 @@
- [C.L.I. Home](CLI-Home)
- [Using the Console Program](Using-the-Console-Program)
- [Console A.P.I.](Console-API)
- [C.L.I. Aliases](CLI-Aliases)
### As a NuGet

Loading…
Cancel
Save