Permalink
Browse files

Restored correct README

  • Loading branch information...
1 parent fded284 commit 57f38ee0172d743848b3bf09e6d73ade82baa21d @LorenzMeier LorenzMeier committed Feb 3, 2012
Showing with 26 additions and 3 deletions.
  1. +26 −3 README
View
29 README
@@ -1,5 +1,28 @@
-THIS REPOSITORY IS OUTDATED!
+MAVLink Micro Air Vehicle Message Marshalling Library
-PLEASE USE https://github.com/mavlink/mavlink FROM NOW ON!
+This is a library for lightweight communication between
+Micro Air Vehicles (swarm) and/or ground control stations.
+It serializes C-structs for serial channels and can be used with
+any type of radio modem.
-THE NEW REPOSITORY HAS v1.0 of MAVLINK AS MASTER BRANCH. V0.9 IS IN THE "v0.9" BRANCH.
+For help, please visit the mailing list: http://groups.google.com/group/mavlink
+
+MAVLink is licensed under the terms of the Lesser General Public License of the Free Software Foundation (LGPL).
+As MAVLink is a header-only library, compiling an application with it is considered "using the libary", not a derived work. MAVLink can therefore be used without limits in any closed-source application without publishing the source code of the closed-source application.
+
+To generate/update packets, select mavlink_standard_message.xml
+in the QGroundControl station settings view, select mavlink/include as
+the output directory and click on "Save and Generate".
+You will find the newly generated/updated message_xx.h files in
+the mavlink/include/generated folder.
+
+To use MAVLink, #include the <mavlink.h> file, not the individual
+message files. In some cases you will have to add the main folder to the include search path as well. To be safe, we recommend these flags:
+
+gcc -I mavlink/include -I mavlink/include/<your message set, e.g. common>
+
+For more information, please visit:
+
+http://qgroundcontrol.org/mavlink/
+
+(c) 2009-2012 Lorenz Meier <mail@qgroundcontrol.org>

0 comments on commit 57f38ee

Please sign in to comment.