Skip to content

Commit 382ed2c

Browse files
committed
Add $ to bash commands, highlight TODO
1 parent 943bc46 commit 382ed2c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ ToDo
3939
The glkernel-cli tool provides a convenient way to generate and manipulate kernels using the command line.
4040
The usage is as follows:
4141

42-
```sh
42+
```
4343
glkernel-cli [--force] [--beautify] [--output <outputFileName>] [--format <outputFileFormat>] <inputFileName>
4444
4545
Options:
@@ -59,12 +59,12 @@ Options:
5959
Kernels can be generated from JavaScript by simply passing a `.js` file as input to the command line tool.
6060
Examples:
6161

62-
```sh
63-
glkernel-cli kernel.js
62+
```
63+
$ glkernel-cli kernel.js
6464
65-
glkernel-cli kernel.js -o random_noise_kernel.json --force --beautify
65+
$ glkernel-cli kernel.js -o random_noise_kernel.json --force --beautify
6666
67-
glkernel-cli kernel.js -o sorted_kernel -f png
67+
$ glkernel-cli kernel.js -o sorted_kernel -f png
6868
```
6969

7070
A JavaScript interface (`JSInterface.h`, `JSInterface.cpp`, `glkernel.js`) allows calling glkernel functionality from user scripts.
@@ -102,10 +102,10 @@ After generating a kernel in JSON format, that kernel can be read by the tool to
102102
This is achieved by simply passing a `.json` file as input to the command line tool.
103103
Examples:
104104

105-
```sh
106-
glkernel-cli kernel.json
105+
```
106+
$ glkernel-cli kernel.json
107107
108-
glkernel-cli kernel.json -o sorted_kernel -f png --force
108+
$ glkernel-cli kernel.json -o sorted_kernel -f png --force
109109
```
110110

111111
If no output file or format is given, the default output format is PNG.
@@ -114,16 +114,16 @@ If no output file or format is given, the default output format is PNG.
114114

115115
The JavaScript interface files can simply be re-generated using the CMake `generate` target, either from your IDE, or from the project's root folder using the following CMake command:
116116

117-
```sh
118-
cmake --build ./build --target generate
117+
```
118+
$ cmake --build ./build --target generate
119119
```
120120

121121
This requires Python 2 or 3 to be installed on the system.
122122
Alternatively, the Python script can be executed manually (also from the root folder):
123123

124-
TODO: update this if the destination of JS and C++ files are different
125-
```sh
126-
python scripts/generate.py -t scripts/templates -d source/tools/glkernel-cli
124+
__TODO__: update this if the destination of JS and C++ files are different
125+
```
126+
$ python scripts/generate.py -t scripts/templates -d source/tools/glkernel-cli
127127
```
128128

129129
##### glkernel-cmd

0 commit comments

Comments
 (0)