Reorganize docs
Esse commit está contido em:
@@ -0,0 +1,4 @@
|
||||
Becoming a Contributor
|
||||
======================
|
||||
|
||||
To be written. Outline the process of becoming a contributor.
|
||||
@@ -0,0 +1,49 @@
|
||||
Building from source
|
||||
====================
|
||||
|
||||
OSX & Linux
|
||||
-----------
|
||||
|
||||
Before getting started:
|
||||
|
||||
* Installed the latest version of `Go <http://golang.org/doc/install>`_ (1.2 as
|
||||
of writing this)
|
||||
* Configure a ``$GOPATH`` (e.g. via adding ``export GOPATH="${HOME}/go"`` to
|
||||
your ``~/.profile``)
|
||||
* Add ``$GOPATH/bin`` to your ``$PATH`` (e.g. via adding ``export
|
||||
PATH="${GOPATH}/bin:${PATH}"`` to your ``~/.profile``)
|
||||
|
||||
Run the commands below to make sure you're in good shape::
|
||||
|
||||
$ go version
|
||||
go version go1.2 darwin/amd64
|
||||
$ go env GOPATH
|
||||
/Users/felix/code/go
|
||||
$ echo "${PATH}" | grep -q "$(go env GOPATH)/bin" && echo "good" || echo "bad"
|
||||
good
|
||||
|
||||
Next, you will need to setup Go for cross compiling to Linux/ARM. Luckily this
|
||||
only takes a minute. The fastest way is this::
|
||||
|
||||
$ cd $(go env GOROOT)/src
|
||||
$ GOOS=linux GOARCH=arm ./make.bash --no-clean
|
||||
|
||||
If this doesn't work for you for some reason, you may try to follow Dave
|
||||
Cheney's `guide for cross compiling Go
|
||||
<http://dave.cheney.net/2012/09/08/an-introduction-to-cross-compilation-with-go>`_
|
||||
instead.
|
||||
|
||||
With Go installed and ready, download GoDrone using ``go get`` (ignore the *"no
|
||||
buildable Go source files in"* warning)::
|
||||
|
||||
$ go get github.com/felixge/godrone
|
||||
$ cd $(go env GOPATH)/src/github.com/felixge/godrone
|
||||
$ ls -lah
|
||||
# should list the GoDrone source files
|
||||
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Building on windows is probably also doable, but has not been attempted yet.
|
||||
Please contribute to the docs if you get it working.
|
||||
@@ -0,0 +1,2 @@
|
||||
Contributing Docs
|
||||
=================
|
||||
@@ -0,0 +1,5 @@
|
||||
Reverse Engineering
|
||||
===================
|
||||
|
||||
To be written. This document will introduce the basic techniques used for
|
||||
reverse engineering the Parrot AR Drone and the original firmware.
|
||||
@@ -0,0 +1,5 @@
|
||||
Vagrant
|
||||
=======
|
||||
|
||||
mkdir -p src/github.com/felixge
|
||||
ln -fs "$(pwd)" "$(pwd)/src/github.com/felixge/godrone"
|
||||
+11
-6
@@ -23,16 +23,21 @@ User Manual
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting_started
|
||||
config
|
||||
faq
|
||||
community
|
||||
changelog
|
||||
user/getting_started
|
||||
user/config
|
||||
user/faq
|
||||
user/community
|
||||
user/changelog
|
||||
|
||||
|
||||
Contributor Manual
|
||||
------------------
|
||||
|
||||
To be written ...
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributor/becoming
|
||||
contributor/building
|
||||
contributor/reverse_engineering
|
||||
|
||||
.. [#license] GoDrone is licensed under the `AGPLv3 license <https://github.com/felixge/godrone/blob/master/LICENSE.txt>`_.
|
||||
|
||||
@@ -118,6 +118,18 @@ becomes more popular than expected, the plan is to rewrite the stabilization
|
||||
loop in C, run it on a separate thread with strong scheduling guarantees, and
|
||||
use some form of IPC to communicate with it.
|
||||
|
||||
Why aren't you building on existing projects?
|
||||
---------------------------------------------
|
||||
|
||||
This project is about exploring what it would be like to build a drone firmware
|
||||
using a high level language, and embracing web technologies for providing a
|
||||
portable user interface.
|
||||
|
||||
Other projects are certainly more mature at this point, and e.g. `Paparazzi
|
||||
<http://paparazzi.enac.fr/wiki/Main_Page>`_ already has support for the AR
|
||||
Drone 2. However, they are significantly more difficult to run and work with,
|
||||
and it would be rather difficult to attempt
|
||||
|
||||
.. _source:
|
||||
|
||||
Where can I get the source code?
|
||||
Referência em uma Nova Issue
Bloquear um usuário