Skip to content

Commit 9192b86

Browse files
author
Zsolt Borbély
authored
Update the webpage (#5127)
The GitHub ribbon is also revived. Related issue: #5125 JerryScript-DCO-1.0-Signed-off-by: Zsolt Borbély [email protected]
1 parent d0671c4 commit 9192b86

14 files changed

+2662
-3577
lines changed

00.GETTING-STARTED.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Several scripts and tools help the building and development process, thus it is
2121

2222
- `bash` >= `4.3.11`
2323
- `cppcheck` >= `1.61`
24-
- `vera++` >= `1.2.1`
24+
- `clang-format-10` >= `10.0.0`
2525
- `python` >= `2.7.6`
2626

2727
```bash
28-
sudo apt-get install gcc gcc-arm-none-eabi cmake cppcheck vera++ python
28+
sudo apt-get install gcc gcc-arm-none-eabi cmake cppcheck clang-format-10 python
2929
```
3030

3131
To make our scripts run correctly, several shell utilities should be available on the system:
@@ -61,10 +61,10 @@ tools/build.py --debug --logging=on --error-messages=on --line-info=on
6161
python tools/build.py --cmake-param=CMAKE_PARAM
6262
```
6363

64-
**Set a profile mode (ES.next, ES5.1, minimal)**
64+
**Set a profile mode (es.next, minimal)**
6565

6666
```bash
67-
python tools/build.py --profile=es.next|es5.1|minimal
67+
python tools/build.py --profile=es.next|minimal
6868
```
6969

7070
See also the related [README.md](https://github.com/jerryscript-project/jerryscript/blob/master/jerry-core/profiles/README.md).
@@ -183,10 +183,10 @@ python tools/run-tests.py --check-signed-off
183183
python tools/run-tests.py --check-cppcheck
184184
```
185185

186-
**To run vera check**
186+
**To run format check**
187187

188188
```bash
189-
python tools/run-tests.py --check-vera
189+
python tools/run-tests.py --check-format
190190
```
191191

192192
**To get a list of all the available test options**

01.CONFIGURATION.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ that can be used by the debugger to identify the currently executed source conte
5454
### Profiles
5555

5656
This option can be used to enable/disable available JavaScript language features by providing profile files. Profile files contain a list of C definitions that configure each individual feature.
57-
The `path` value for CMake and Python arguments should be a file path to the profile file, or one of `es.next`, `es5.1`, or `minimal`, which are the pre-defined profiles.
57+
The `path` value for CMake and Python arguments should be a file path to the profile file, or one of `es.next` or `minimal`, which are the pre-defined profiles.
5858
To see how a profile file should be created, or what configuration options are available in C, see the profile [README](https://github.com/jerryscript-project/jerryscript/blob/master/jerry-core/profiles/README.md).
5959

6060
| Options | |
@@ -200,7 +200,7 @@ This option is enabled by default.
200200

201201
### Memory statistics
202202

203-
This option can be used to provide memory usage statistics either upon engine termination, or during runtime using the `jerry_get_memory_stats` jerry API function.
203+
This option can be used to provide memory usage statistics either upon engine termination, or during runtime using the `jerry_heap_stats` jerry API function.
204204
The feature can create a significant performance overhead, and should only be used for measurement purposes. This option is disabled by default.
205205

206206
| Options | |
@@ -309,7 +309,7 @@ in other projects. To achieve this, the following command can be executed to cre
309309
into the `amalgam` directory:
310310

311311
```sh
312-
$ python tools/amalgam.py --output-dir amalgam --jerry-core --jerry-port-default --jerry-math
312+
$ python tools/amalgam.py --output-dir amalgam --jerry-core --jerry-port --jerry-math
313313
```
314314

315315
(Note: In the example above, the command is executed from the project's root directory, but that is
@@ -320,8 +320,7 @@ The command creates the following files in the `amalgam` dir:
320320
* `jerryscript.c`
321321
* `jerryscript.h`
322322
* `jerryscript-config.h`
323-
* `jerryscript-port-default.c`
324-
* `jerryscript-port-default.h`
323+
* `jerryscript-port.c`
325324
* `jerryscript-math.c`
326325
* `math.h`
327326

@@ -333,7 +332,7 @@ These files can be directly compiled with an application using the JerryScript A
333332
E.g., using a command similar to the one below:
334333

335334
```sh
336-
$ gcc -Wall -o demo_app demo_app.c amalgam/jerryscript.c amalgam/jerryscript-port-default.c amalgam/jerryscript-math.c -Iamalgam/
335+
$ gcc -Wall -o demo_app demo_app.c amalgam/jerryscript.c amalgam/jerryscript-port.c amalgam/jerryscript-math.c -Iamalgam/
337336
```
338337

339338
(Note: The headers must be available on the include path.)

0 commit comments

Comments
 (0)