vilhjalmur89 / Devguide

PX4 Devguide GitBook

PX4 Developer Guide

This guide is published by Travis CI online at: http://dev.px4.io/

Prerequisites

To start editing, install GitBook (requires Node.js):

On Mac OS:

brew install npm

On Linux - you're using Linux, so you should know!

sudo apt-get install npm

Installing Gitbook

npm install grunt-cli -g
npm install gitbook-cli -g

Change to the directory of this repo:

cd px4devguide
npm install
gitbook install book

Running

Build once with grunt every time the HTML template changes:

grunt

Then view it locally. NOTE: The local view will update when the markup files are changed, so there is no need to re-run this command.

gitbook serve book

Open http://localhost:4000/. Files will update live as you edit them.

See CONTRIBUTING.md for information on how to submit to this guide.

Deployment

Install required packages:

sudo gem install dotenv aws-sdk thread bundler git mime

export BUCKET=dev.px4.io
export AWS_KEY=[KEY]
export AWS_SECRET=[SECRET]
./deploy.rb

License

Content: CC-BY, (c) PX4 Project

Template: CC-BY, stolen from the Solo dev guide.