Commit efe8e8b2 authored by Bryant's avatar Bryant

Corrected repository layout section of the README.

Reduced it to folder descriptions and important files.
parent a1be8b0c
......@@ -131,82 +131,22 @@ Windows XP/7:
## Repository Layout
qgroundcontrol:
demo-log.txt
license.txt
qgcunittest.pro - For the unit tests.
qgcunittest.pro.user
qgcvideo.pro
qgroundcontrol.pri - Used by qgroundcontrol.pro
qgroundcontrol.pro - Project opened in QT to run qgc.
qgroundcontrol.pro.user
qgroundcontrol.qrc - Holds many images.
qgroundcontrol.rc - line of code to point toward the images
qserialport.pri - generated by qmake.
testlog.txt - sample log file
testlog2.txt - sample log file
user_config.pri.dist - Custom message specs to be added here.
data:
Maps from yahoo and kinect and earth.
deploy:
Install and uninstall for win32.
Create a debian packet.
Create .DMG file for publishing for mac.
Audio test on mac.
doc:
Doxyfile is in this directory and information for creating html documentation for qgc.
files:
Has the audio for the vehicle and data output.
ardupilotmega:
widgets and tool tips for pilot heading for the fixed wing.
tooltips for quadrotor
flightgear:
Aircraft:
Different types of planes and one jeep.
Protocol:
The protocol for the fixed_wings and quadrotor and quadhil.holds info about the fixed wing yaw, roll etc.
Quadrotor:
Again holds info about yaw, roll etc.
Pixhawk:
Widgets for hexarotor. Widgets and tooltips for quadrotor.
vehicles:
different vehicles. Seems to hold the different kinds of aircrafts as well as files for audio and the hexarotor and quadrotor.
widgets:
Has a lot of widgets defined for buttons and sliders.
images:
For the UI. Has a bunch of different images such as images for applications or actions or buttons.
lib:
SDL is located in this direcotry.
Msinttypes:
Defines intteger types for microsoft visual studio.
sdl:
Information about the library and to run the library on different platforms.
mavlink:
The files for the library mavlink.
qgcunittest:
Has the unittests for qgc
settings:
Parameter lists for alpha, bravo and charlie. Data for stereo, waypoints and radio calibration.
src:
Code for QGCCore, audio output, configuration, waypoints, main and log compressor.
apps
Code for mavlink generation and for a video application.
comm
Code for linking to simulation, mavlink, udp, xbee, opal, flight gear and interface.
Has other libraries. Qwt is in directory named lib. The other libraries are in libs.
lib
qwt library
libs
eigen, opmapcontrol, qestserialport, qtconcurrent, utils.
input
joystick and freenect code.
plugins
Qt project for PIXHAWK plugins.
uas
Ardu pilot, UAS, mavlink factory, uas manager, interface, waypoint manager and slugs.
ui
Has code for data plots, waypoint lists and window congfiguration. All of the ui code.
thirdParty:
Library called lxbee.
Library called QSerialPort.
The following describes the directory structure and important files in the QGroundControl repository
Folders:
* data - Miscellaneous support files.
* deploy - Contains scripts for packaging QGC for all supported systems.
* doc - Output directory for generated Doxygen documentation. See README contained within for details.
* files - Contains miscellaneous data including vehicle models and autopilot-specific data files.
* images - UI images.
* libs - Library dependencies for QGC.
* qupgrade - Source file for the qupgrade, a firmware flashing utility for the APM. Compiled into QGC by default.
* qml - QML source files for the project.
* src - Source code for QGroundControl. Split into subfolders for communications, user interface, autopilot-specific files, etc.
* tools - Additional tools for developers.
Important files:
* qgroundcontrol.pro - Primary project file for building QGC. Open this in qtcreator or pass this to qmake on the command line to build QGC.
* qgcvideo.pro - Builds a standalone executable for viewing UDP video streams from a vehicle.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment