Skip to content

Commit 69761da

Browse files
committed
Documentation is moved to docs.
- DEVELOPMENT.md is extended with bash utilites. - Internals doc added and DEVELOPEMENT is renamed to GETTING-STARTED. - modified image links in Internals - links are fixed in README.md JerryScript-DCO-1.0-Signed-off-by: István Kádár ikadar@inf.u-szeged.hu
1 parent 130be84 commit 69761da

14 files changed

+349
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ cd jerryscript
3030
make release.linux -j
3131
```
3232

33-
For additional information see [Development](docs/DEVELOPMENT.md).
33+
For additional information see [Getting Started](docs/GETTING-STARTED.md).
3434

3535
## Documentation
3636
- [API Reference](docs/API-REFERENCE.md)
3737
- [API Example](docs/API-EXAMPLE.md)
38+
- [Internals](docs/INTERNALS.md)
3839

3940
## License
4041
JerryScript is Open Source software under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). Complete license and copyright information can be found in the source code.

docs/DEVELOPMENT.md renamed to docs/GETTING-STARTED.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
## Development
21
### Setting Up Prerequisites
2+
33
Currently, only Ubuntu 14.04+ is officially supported as primary development environment.
44

55
There are several dependencies, that should be installed manually. The following list is required for building:
6+
67
- `gcc` higher than `4.8.2`
78
- native
89
- arm-none-eabi
@@ -16,34 +17,51 @@ There are several dependencies, that should be installed manually. The following
1617
sudo apt-get install gcc g++ gcc-arm-none-eabi cmake cppcheck vera++
1718
```
1819

20+
To make our scripts run correctly, several shell utilities should be available on the system:
21+
22+
- `find`
23+
- `bc`
24+
- `awk`
25+
- `sed`
26+
- `sha256sum`
27+
- `wget`
28+
1929
Upon first build, `make` would try to setup prerequisites, required for further development and pre-commit testing:
30+
2031
- STM32F3 and STM32F4 libraries
2132

2233
```bash
2334
make prerequisites -j
2435
```
36+
2537
It may take time, so go grab some coffee:
2638

2739
```bash
2840
Setting up prerequisites... (log file: ./build/prerequisites/prerequisites.log)
2941
```
3042

3143
### Building Debug Version
44+
3245
To build debug version for Linux:
46+
3347
```bash
3448
make debug.linux -j
3549
```
3650

3751
To build debug version for Linux without LTO (Link Time Optimization):
52+
3853
```bash
3954
LTO=OFF make debug.linux -j
4055
```
4156

4257
### Checking Patch
58+
4359
```bash
4460
make precommit -j
4561
```
62+
4663
If some style guidelines, build or test runs fail during precommit, then this is indicated with a message like this:
64+
4765
```
4866
Build failed. See ./build/bin/unittests/make.log for details.
4967
```

docs/INTERNALS.md

Lines changed: 328 additions & 0 deletions
Large diffs are not rendered by default.

docs/img/CBC_layout.png

8.63 KB
Loading

docs/img/bytecode-layout.png

10.3 KB
Loading

docs/img/ecma_compressed.png

5.09 KB
Loading

docs/img/ecma_lcache.png

17.6 KB
Loading

docs/img/ecma_object.png

27 KB
Loading

docs/img/ecma_object_property.png

33.4 KB
Loading

docs/img/ecma_value.png

7.02 KB
Loading

0 commit comments

Comments
 (0)