Skip to content

Commit 372a2bb

Browse files
author
Tilmann Scheller
committed
Cleanup README and add official IRC channel and mailing list.
JerryScript-DCO-1.0-Signed-off-by: Tilmann Scheller t.scheller@samsung.com
1 parent a816ab8 commit 372a2bb

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,43 @@
11
![](https://github.com/Samsung/jerryscript/blob/master/LOGO.png)
2-
# JerryScript: JavaScript engine for Internet of Things
3-
[![Join the chat at https://gitter.im/Samsung/jerryscript](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Samsung/jerryscript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2+
# JerryScript: JavaScript engine for the Internet of Things
43
[![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)
54
[![Build Status](https://travis-ci.org/Samsung/jerryscript.svg?branch=master)](https://travis-ci.org/Samsung/jerryscript)
65

6+
JerryScript is a lightweight JavaScript engine for resource-constrained devices such as microcontrollers. It can run on devices with less than 64 KB of RAM and less than 200 KB of flash memory.
77

8-
JerryScript is the lightweight JavaScript engine for very constrained devices such as microcontrollers:
9-
- Only few kilobytes of RAM available to the engine (<64 KB RAM)
10-
- Constrained ROM space for the code of the engine (<200 KB ROM)
8+
Key characteristics of JerryScript:
9+
* Full ECMAScript 5.1 standard compliance
10+
* 170K binary size when compiled for ARM Thumb-2
11+
* Heavily optimized for low memory consumption
12+
* Written in C99 for maximum portability
13+
* Snapshot support for precompiling JavaScript source code to byte code
14+
* Mature C API, easy to embed in applications
1115

12-
Additional informantion can be found on our [project page](http://samsung.github.io/jerryscript/) and [wiki](https://github.com/Samsung/jerryscript/wiki).
16+
Additional information can be found on our [project page](http://samsung.github.io/jerryscript) and [Wiki](https://github.com/Samsung/jerryscript/wiki).
17+
18+
IRC channel: #jerryscript on [freenode](https://freenode.net)
19+
Mailing list: jerryscript-dev@gna.org, you can subscribe [here](https://mail.gna.org/listinfo/jerryscript-dev) and access the mailing list archive [here](https://mail.gna.org/public/jerryscript-dev).
1320

1421
## Quick Start
15-
### Getting Sources
22+
### Getting the sources
1623
```bash
17-
git clone https://github.com/Samsung/jerryscript.git jr
18-
cd jr
24+
git clone https://github.com/Samsung/jerryscript.git
25+
cd jerryscript
1926
```
2027

21-
### Building
28+
### Building JerryScript
2229
```bash
2330
make release.linux -j
2431
```
2532

26-
For Additional information see [Development](docs/DEVELOPMENT.md).
33+
For additional information see [Development](docs/DEVELOPMENT.md).
2734

2835
## Documentation
2936
- [API Reference](docs/API-REFERENCE.md)
3037
- [API Example](docs/API-EXAMPLE.md)
3138

3239
## License
33-
JerryScript is Open Source software under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Complete license and copyright information can be found within the code.
40+
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.
3441

3542
> Copyright 2015 Samsung Electronics Co., Ltd.
3643

0 commit comments

Comments
 (0)