forked from robovm/robovm-docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Joseph Hager
committed
Mar 31, 2015
1 parent
9109a94
commit e717f40
Showing
143 changed files
with
6,789 additions
and
3,048 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 |
---|---|---|
@@ -1,5 +1,6 @@ | ||
.DS_STORE | ||
target/ | ||
_book | ||
pom.xml.tag | ||
pom.xml.releaseBackup | ||
pom.xml.versionsBackup | ||
|
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 @@ | ||
* [English](en) |
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,10 +1,32 @@ | ||
RoboVM Documentation Project | ||
=========== | ||
# RoboVM Documentation Project | ||
|
||
To generate the docs run | ||
## Development | ||
|
||
Docs are written in [markdown](http://daringfireball.net/projects/markdown/syntax), and rendered using [gitbook](https://github.com/GitbookIO/gitbook). | ||
|
||
Make sure you have [npm](https://www.npmjs.com/) installed and run | ||
|
||
```bash | ||
npm install gitbook -g | ||
gitbook serve . | ||
``` | ||
mvn package | ||
|
||
This will start a server, watch for changes to files, and automatically refresh the browser when the build completes. | ||
|
||
## Deployment | ||
|
||
The book can be built for deployment using | ||
|
||
```bash | ||
gitbook build . | ||
``` | ||
|
||
This project also comes with a `guard` file which can be used to get a live preview when editing the asciidoc source files. For instructions see: http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/. | ||
There are options for rendering to pdf and epub, but the default is to output a website in the _book directory. | ||
|
||
## Contributing | ||
|
||
This book has been written by various RoboVM contributors. | ||
|
||
If you notice any errors or would like to help out, please use Github issues to discuss any changes so that work will not be duplicated. | ||
|
||
All content is licensed under the [Creative Commons Attribution Non Commercial Share Alike 4.0 license](http://creativecommons.org/licenses/by-nc-sa/4.0/). |
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,13 @@ | ||
{ | ||
"gitbook": ">=2.0.0", | ||
"theme": "./theme", | ||
"title": "RoboVM User Guide", | ||
"structure": { | ||
"readme": "introduction.md" | ||
}, | ||
"variables": { | ||
"appVersion": "1.0.0", | ||
"osxVersion": "10.9", | ||
"xcodeVersion": "6.x" | ||
} | ||
} |
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,17 @@ | ||
# Summary | ||
|
||
* [Getting Started](getting-started/introduction.md) | ||
* [Getting Started with Eclipse](getting-started/eclipse.md) | ||
* [Getting Started with IntelliJ](getting-started/intellij.md) | ||
* [Getting Started with Maven](getting-started/maven.md) | ||
* [Getting Started with Gradle](getting-started/gradle.md) | ||
* [Project and Code Structure](getting-started/structure.md) | ||
* [Samples](samples.md) | ||
* [Configuration Reference](configuration.md) | ||
* [Advanced Topics](advanced-topics/introduction.md) | ||
* [Under the Hood](advanced-topics/compilation.md) | ||
* [Using RAM Disks](advanced-topics/ramdisks.md) | ||
* [Using the Latest Nightly Build](advanced-topics/nightlies.md) | ||
* [Using the Latest Nightly Build](advanced-topics/nightlies.md) | ||
* [The Bro Java to Native Bridge](advanced-topics/bro.md) | ||
* [Command Line Usage](advanced-topics/commandline.md) |
Oops, something went wrong.