Skip to content

Documentation is moved to docs. #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ cd jerryscript
make release.linux -j
```

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

## Documentation
- [API Reference](docs/API-REFERENCE.md)
- [API Example](docs/API-EXAMPLE.md)
- [Internals](docs/INTERNALS.md)

## License
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.
Expand Down
20 changes: 19 additions & 1 deletion docs/DEVELOPMENT.md → docs/GETTING-STARTED.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## Development
### Setting Up Prerequisites

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

There are several dependencies, that should be installed manually. The following list is required for building:

- `gcc` higher than `4.8.2`
- native
- arm-none-eabi
Expand All @@ -16,34 +17,51 @@ There are several dependencies, that should be installed manually. The following
sudo apt-get install gcc g++ gcc-arm-none-eabi cmake cppcheck vera++
```

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

- `find`
- `bc`
- `awk`
- `sed`
- `sha256sum`
- `wget`

Upon first build, `make` would try to setup prerequisites, required for further development and pre-commit testing:

- STM32F3 and STM32F4 libraries

```bash
make prerequisites -j
```

It may take time, so go grab some coffee:

```bash
Setting up prerequisites... (log file: ./build/prerequisites/prerequisites.log)
```

### Building Debug Version

To build debug version for Linux:

```bash
make debug.linux -j
```

To build debug version for Linux without LTO (Link Time Optimization):

```bash
LTO=OFF make debug.linux -j
```

### Checking Patch

```bash
make precommit -j
```

If some style guidelines, build or test runs fail during precommit, then this is indicated with a message like this:

```
Build failed. See ./build/bin/unittests/make.log for details.
```
328 changes: 328 additions & 0 deletions docs/INTERNALS.md

Large diffs are not rendered by default.

Binary file added docs/img/CBC_layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/bytecode-layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ecma_compressed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ecma_lcache.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ecma_object.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ecma_object_property.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ecma_value.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/engines_high_level_design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/number.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/opcode_layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/parser_dependency.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.