forked from jerryscript-project/iotjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhance readability of documents (jerryscript-project#1026)
- 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
Showing
29 changed files
with
257 additions
and
289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
1 change: 0 additions & 1 deletion
1
docs/build/Build-for-ARTIK.md → docs/build/Build-for-ARTIK10-Tizen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
## Build IoT.js for ARTIK | ||
|
||
### Tizen on ARTIK10 cross-compile | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.