Skip to content

Commit

Permalink
Enhance readability of documents (jerryscript-project#1026)
Browse files Browse the repository at this point in the history
- Add link menu in Home main page
- Synchronize with wiki
- Make 'Build-for-STM32F4-Nuttx' more readable
- Rename files and rearrange folder
- Fix the wrong things

IoT.js-DCO-1.0-Signed-off-by: Hosung Kim [email protected]
  • Loading branch information
hs0225 authored and yichoi committed Jul 9, 2017
1 parent 8a33a81 commit 9ad0d48
Show file tree
Hide file tree
Showing 29 changed files with 257 additions and 289 deletions.
4 changes: 4 additions & 0 deletions docs/Developer's-Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
To contribute to the IoT.js Project (such as reporting bugs and submitting patches):
* Follow the [Development Process](devs/Development-Process.md) and [GitHub contributor guidelines](https://guides.github.com/activities/contributing-to-open-source/).
* Add the [IoT.js DCO](devs/IoT.js-Developer's-Certificate-of-Origin-1.0.md) signoff to each commit message during development.
* Add the [License](License.md) if you introduce any new source code or script files
24 changes: 24 additions & 0 deletions docs/Getting-Started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### Supported platforms
Current supported platforms are **Linux and NuttX**

OSX 10.10 as development host

* [Build for x86 / Linux](build/Build-for-x86-Linux.md): Ubuntu 14.04 is used as a base platform.
* [Build for Stm32f4 / NuttX](build/Build-for-STM32F4-NuttX.md)
* [Build for Raspberry Pi 2 / Linux](build/Build-for-RPi2-Linux.md)

#### H/W boards
* Current supporting
* STM32F4-Discovery + BB
* Raspberry Pi 2
* Plan to support
* Samsung Artik 053
* Samsung Artik 10
* (and your contributions including above plans)

We will support the correct behavior of APIs for above environments. However, since IoT.js is targeting various kind IoT devices and platforms, single implementation cannot be the best practice for every environments. Therefore embedders should be in charge of optimization for their own environments. For more details on optimization, see the [Optimization Tips](devs/Optimization-Tips.md) page.


### Build script
There is a script to help you build IoT.js called "[build.py](https://github.com/Samsung/iotjs/blob/master/tools/build.py)" in source repository.

31 changes: 22 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
Welcome to the IoT.js!

* If you would like to try IoT.js, please check [Getting Started](help/Getting-Started.md).
* If you would like to jump into IoT.js, please follow [Development Process](help/Development-Process.md) of IoT.js.

### IoT.js
- Project Overview
> IoT.js is a framework for "Internet of Things" built on
> lightweight JavaScript interpreter ['JerryScript'](https://github.com/jerryscript-project/jerryscript)
> and libtuv for event driven(non-blocking I/O model) similar to node.js.
### IoT.js Wiki

**About**
- [License](License.md)
<br>
- [Governance](contributing/Governance.md)

**[Getting Started](Getting-Started.md)**
- [x86 / Linux](build/Build-for-x86-Linux.md)
- [Raspberry Pi 2 / Linux](build/Build-for-RPi2-Linux.md)
- [Stm32f4 / NuttX](build/Build-for-STM32F4-NuttX.md)

**[Developer Guide](Developer's-Guide.md)**
- [Development Process](devs/Development-Process.md)
- [Certificate of Origin](devs/IoT.js-Developer's-Certificate-of-Origin-1.0.md)
- [Test Guidelines](devs/Test-Guidelines.md)
- [Coding Style Guidelines](devs/Coding-Style-Guidelines.md)
- [API Document Guidelines](devs/API-Document-Guidelines.md)
- [Developer Tutorial](devs/Developer-Tutorial.md)
- [Advanced Development](devs/Advanced-Development.md)
- [IoT.js API Reference](api/IoT.js-API-reference.md)

### [Getting Started](help/Getting-Started.md) - Developer guide
### [Getting Involved](help/Getting-involved.md)
### Roadmap(TBD)
**Contributing**
- [Patch Submission Process](contributing/Patch-Submission-Process.md)
- [Community Guideline](contributing/Community-Guidelines.md)
- [Assigned People](contributing/Assigned-People.md)
2 changes: 1 addition & 1 deletion docs/build/Build-Script.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can build IoT.js with default setting for your host machine with;
```
./tools/build.py
```
The command will generate runnable IoT.js binary in "./build/<arch-os>/debug/iotjs/iotjs".
The command will generate runnable IoT.js binary in "./build/<arch-os>/debug/bin/iotjs".

You can also build release binary with;
```
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
## Build IoT.js for ARTIK

### Tizen on ARTIK10 cross-compile

Expand Down
134 changes: 0 additions & 134 deletions docs/build/Build-for-NuttX.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
## Build IoT.js with Raspberry Pi 2

IoT.js supports two build types:

Expand Down Expand Up @@ -111,7 +110,7 @@ Give `target-arch`, `target-os` and `target-board` options to the script named '

#### Running in Raspberry Pi 2

This script gives you `build/arm-linux/release/iotjs/iotjs` or `build/arm-linux/debug/iotjs/iotjs`.
This script gives you `build/arm-linux/release/bin/iotjs` or `build/arm-linux/debug/bin/iotjs`.
Copy this binary with your favorite tool or `scp` like below.

``` bash
Expand Down
Loading

0 comments on commit 9ad0d48

Please sign in to comment.