forked from tessel/t2-docs
-
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.
fixes setup and some files for consistency
- adds a package.json for easier setup - renames network-api for consistency - fixes some links to point to new gitbook paths - removes Python from supported languages list
- Loading branch information
1 parent
82697de
commit 484c929
Showing
8 changed files
with
55 additions
and
24 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 |
---|---|---|
|
@@ -14,3 +14,4 @@ _book | |
*.epub | ||
*.mobi | ||
npm-debug.log |
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,5 +1,4 @@ | ||
# Supported languages | ||
|
||
* JavaScript/Node | ||
* [Python (work in progress)](https://github.com/tessel/tessel-python) | ||
* [JavaScript/Node](https://github.com/tessel/t2-firmware) | ||
* [Rust (work in progress)](https://github.com/tessel/rust-tessel) |
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.
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,16 +1,19 @@ | ||
Developer guide to Tessel 2 Docs Gitbook | ||
============ | ||
|
||
# Tools | ||
Install the following command line tools using `npm i {{toolname}} -g` | ||
# Requirements | ||
The docs are build using a command line tool called [GitBook](https://www.npmjs.com/package/gitbook), which requires: | ||
|
||
* [gitbook](https://www.npmjs.com/package/gitbook) | ||
* [gitbook-summary](https://github.com/imfly/gitbook-summary) | ||
* [Node Version 4 or higher](https://nodejs.org/en/) | ||
* [NPM Version 2 or higher](https://docs.npmjs.com/getting-started/installing-node) | ||
|
||
# Running locally | ||
|
||
Clone, `npm install`, and `gitbook serve` | ||
* `git clone https://github.com/tessel/t2-docs.git` | ||
* `cd t2-docs` | ||
* `npm install` | ||
* `npm start` | ||
|
||
# Changing the contents | ||
|
||
SUMMARY.md is autogenerated using the gitbook-summary tool. The command to regenerate is `book sm`. It receives instructions from book.json. | ||
SUMMARY.md is autogenerated using the gitbook-summary tool, using instructions from `book.json`. The command to regenerate is `npm run build`, which is automatically run during the `npm start` command. |
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,15 +1,16 @@ | ||
# Tessel 2 Documentation | ||
|
||
- API | ||
* [CLI](/API/CLI.md) | ||
* [Hardware API](/API/Hardware_API.md) | ||
* [Languages](/API/Languages.md) | ||
* [Modules](/API/Modules.md) | ||
* [CLI](API/CLI.md) | ||
* [Hardware API](API/Hardware_API.md) | ||
* [Languages](API/Languages.md) | ||
* [Modules](API/Modules.md) | ||
* [Network API](API/Network_API.md) | ||
- Debugging | ||
* [LAN Discovery](/Debugging/LAN_Discovery.md) | ||
* [Repos](/Debugging/Repos.md) | ||
* [USB](/Debugging/USB.md) | ||
* [Introduction](/Introduction.md) | ||
* [LAN Discovery](debugging/LAN_Discovery.md) | ||
* [Repos](debugging/Repos.md) | ||
* [USB](debugging/USB.md) | ||
- Tutorials | ||
* [Communication Protocols](/Tutorials/Communication_Protocols.md) | ||
* [Making Your Own Module](/Tutorials/Making_Your_Own_Module.md) | ||
* [Communication Protocols](Tutorials/Communication_Protocols.md) | ||
* [Making Your Own Module](Tutorials/Making_Your_Own_Module.md) | ||
* [Introduction](Introduction.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
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,27 @@ | ||
{ | ||
"name": "t2-docs", | ||
"version": "1.0.0", | ||
"description": "The documentation site for the Tessel 2", | ||
"dependencies": { | ||
"gitbook-plugin-anchors": "^0.7.0" | ||
}, | ||
"devDependencies": { | ||
"gitbook-cli": "^2.3.0", | ||
"gitbook-summary": "^1.1.2" | ||
}, | ||
"scripts": { | ||
"build": "book sm", | ||
"postinstall": "gitbook install", | ||
"start": "npm run build && gitbook serve" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/tessel/t2-docs.git" | ||
}, | ||
"author": "", | ||
"license": "SEE LICENSE IN LICENSE", | ||
"bugs": { | ||
"url": "https://github.com/tessel/t2-docs/issues" | ||
}, | ||
"homepage": "https://github.com/tessel/t2-docs#readme" | ||
} |