Skip to content

Commit 33842d1

Browse files
committed
📚 Add the new command line switches to the docs
1 parent a411e66 commit 33842d1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/source/index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ complexitty --bindings
6565
complexitty --bindings
6666
```
6767

68+
#### `-c`, `--colour-map`, `--color-map`
69+
70+
Set the colour map to use in the plot.
71+
6872
#### `-h`, `--help`
6973

7074
Prints the help for the `complexitty` command.
@@ -76,6 +80,10 @@ complexitty --help
7680
complexitty --help
7781
```
7882

83+
#### `-i`, `--max-iteration`
84+
85+
Set the maximum number of iterations for the plot's calculation.
86+
7987
#### `--license`, `--licence`
8088

8189
Prints a summary of [Complexitty's license](license.md).
@@ -87,6 +95,10 @@ complexitty --license
8795
complexitty --license
8896
```
8997

98+
#### `-m`, `--multibrot`
99+
100+
Set the 'multibrot' parameter for the plot.
101+
90102
#### `-t`, `--theme`
91103

92104
Sets Complexitty's theme; this overrides and changes any previous theme choice made
@@ -112,6 +124,18 @@ complexitty --version
112124
complexitty --version
113125
```
114126

127+
#### `-x`, `--x-position`
128+
129+
Set the X position of the centre of the plot.
130+
131+
#### `-y`, `--y-position`
132+
133+
Set the Y position of the centre of the plot.
134+
135+
#### `-z`, `--zoom`
136+
137+
Set the amount of zoom to use for the plot.
138+
115139
## Getting help
116140

117141
A great way to get to know Complexitty is to read the help screen. Once in

0 commit comments

Comments
 (0)