Skip to content

Commit

Permalink
Update the webpage (#5127)
Browse files Browse the repository at this point in the history
The GitHub ribbon is also revived.

Related issue: #5125

JerryScript-DCO-1.0-Signed-off-by: Zsolt Borbély zsborbely.u-szeged@partner.samsung.com
  • Loading branch information
bzsolt committed Feb 7, 2024
1 parent d0671c4 commit 9192b86
Show file tree
Hide file tree
Showing 14 changed files with 2,662 additions and 3,577 deletions.
12 changes: 6 additions & 6 deletions 00.GETTING-STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Several scripts and tools help the building and development process, thus it is

- `bash` >= `4.3.11`
- `cppcheck` >= `1.61`
- `vera++` >= `1.2.1`
- `clang-format-10` >= `10.0.0`
- `python` >= `2.7.6`

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

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

**Set a profile mode (ES.next, ES5.1, minimal)**
**Set a profile mode (es.next, minimal)**

```bash
python tools/build.py --profile=es.next|es5.1|minimal
python tools/build.py --profile=es.next|minimal
```

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

**To run vera check**
**To run format check**

```bash
python tools/run-tests.py --check-vera
python tools/run-tests.py --check-format
```

**To get a list of all the available test options**
Expand Down
11 changes: 5 additions & 6 deletions 01.CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ that can be used by the debugger to identify the currently executed source conte
### Profiles

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.
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.
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.
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).

| Options | |
Expand Down Expand Up @@ -200,7 +200,7 @@ This option is enabled by default.

### Memory statistics

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.
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.
The feature can create a significant performance overhead, and should only be used for measurement purposes. This option is disabled by default.

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

```sh
$ python tools/amalgam.py --output-dir amalgam --jerry-core --jerry-port-default --jerry-math
$ python tools/amalgam.py --output-dir amalgam --jerry-core --jerry-port --jerry-math
```

(Note: In the example above, the command is executed from the project's root directory, but that is
Expand All @@ -320,8 +320,7 @@ The command creates the following files in the `amalgam` dir:
* `jerryscript.c`
* `jerryscript.h`
* `jerryscript-config.h`
* `jerryscript-port-default.c`
* `jerryscript-port-default.h`
* `jerryscript-port.c`
* `jerryscript-math.c`
* `math.h`

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

```sh
$ gcc -Wall -o demo_app demo_app.c amalgam/jerryscript.c amalgam/jerryscript-port-default.c amalgam/jerryscript-math.c -Iamalgam/
$ gcc -Wall -o demo_app demo_app.c amalgam/jerryscript.c amalgam/jerryscript-port.c amalgam/jerryscript-math.c -Iamalgam/
```

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

0 comments on commit 9192b86

Please sign in to comment.