Skip to content

Commit e93e326

Browse files
author
Zsolt Borbély
committed
Correct the documentation
- Fix some style issue, typos, and examples - Follow the variable naming conventions - Fix tables both in the project and on the webpage JerryScript-DCO-1.0-Signed-off-by: Zsolt Borbély [email protected]
1 parent 48d5eee commit e93e326

File tree

7 files changed

+180
-153
lines changed

7 files changed

+180
-153
lines changed

docs/01.GETTING-STARTED.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Setting Up Prerequisites
1+
## Setting up prerequisites
22

33
Currently, only Ubuntu 14.04+ is officially supported as primary development environment.
44

@@ -19,38 +19,41 @@ sudo apt-get install gcc g++ gcc-arm-none-eabi cmake cppcheck vera++ python
1919

2020
To make our scripts run correctly, several shell utilities should be available on the system:
2121

22-
- `find`
2322
- `awk`
23+
- `bc`
24+
- `find`
25+
- `sed`
2426

25-
### Building Jerryscript
27+
## Building JerryScript
2628

27-
##### To build debug version for Linux:
29+
**To build debug version for Linux**
2830

2931
```bash
3032
python tools/build.py --debug
3133
```
3234

33-
##### To build debug version for Linux without LTO (Link Time Optimization):
35+
**To build debug version for Linux without LTO (Link Time Optimization)**
3436

3537
```bash
3638
python tools/build.py --debug --lto=off
3739
```
3840

39-
##### Add custom arguments to CMake:
41+
**Add custom arguments to CMake**
4042

4143
```bash
4244
python tools/build.py --cmake-param=CMAKE_PARAM
4345
```
4446

45-
##### Set a profile mode (full|minimal):
47+
**Set a profile mode (full, minimal)**
4648

4749
```bash
4850
python tools/build.py --feature=full|minimal
4951
```
5052

51-
##### Use (jerry|compiler-default|external libc) libc:
53+
**Use (jerry, compiler-default, external) libc**
5254

5355
The default libc is jerry-libc, but you can use compiler-default libc or an external libc:
56+
5457
- compiler-default libc:
5558

5659
```bash
@@ -63,7 +66,7 @@ python tools/build.py --jerry-libc=off --compiler-default-libc=on
6366
python tools/build.py --jerry-libc=off --compiler-default-libc=off --compile-flag="-I/path/to/libc/include"
6467
```
6568

66-
##### Add toolchain file:
69+
**Add toolchain file**
6770

6871
The ```cmake``` dir already contains some usable toolchain files, which you can use in the following format:
6972

@@ -77,72 +80,64 @@ For example the cross-compile to RaspberryPi 2 is something like this:
7780
python tools/build.py --toolchain=cmake/toolchain_linux_armv7l.cmake
7881
```
7982

80-
##### To get a list of all the available buildoptions for Linux:
83+
**To get a list of all the available buildoptions for Linux**
8184

8285
```bash
8386
python tools/build.py --help
8487
```
8588

86-
### Checking patch
89+
## Checking patch
8790

8891
```bash
8992
python tools/run-tests.py --precommit
9093
```
9194

95+
### Running only one type of test
9296

93-
#### Running only one type of test:
94-
95-
##### To run build option tests:
97+
**To run build option tests**
9698

9799
```bash
98100
python tools/run-tests.py --buildoption-test
99101
```
100102

101-
##### To run unittests:
103+
**To run unittests**
102104

103105
```bash
104106
python tools/run-tests.py --unittests
105107
```
106108

107-
##### To run jerry-tests:
109+
**To run jerry-tests**
108110

109111
```bash
110112
python tools/run-tests.py --jerry-tests
111113
```
112114

113-
##### To run jerry-test-suite:
115+
**To run jerry-test-suite**
114116

115117
```bash
116118
python tools/run-tests.py --jerry-test-suite
117119
```
118120

119-
##### To run signed-off check:
121+
**To run signed-off check**
120122

121123
```bash
122124
python tools/run-tests.py --check-signed-off
123125
```
124126

125-
##### To run cppcheck:
127+
**To run cppcheck**
126128

127129
```bash
128130
python tools/run-tests.py --check-cppcheck
129131
```
130132

131-
##### To run vera check:
133+
**To run vera check**
132134

133135
```bash
134136
python tools/run-tests.py --check-vera
135137
```
136138

137-
##### Use toolchain file:
138-
139-
The cmake dir already contains some usable toolchain files, which you can use in the following format:
140-
141-
python tools/run-tests.py --toolchain=TOOLCHAIN
142-
143-
##### To get a list of all the available test options:
139+
**To get a list of all the available test options**
144140

145141
```bash
146142
python tools/run-tests.py --help
147143
```
148-

0 commit comments

Comments
 (0)