From 3bbdba639f4412301538fcf844b582f365b0fc1d Mon Sep 17 00:00:00 2001 From: Jessica Date: Wed, 18 Jul 2012 11:14:44 -0700 Subject: [PATCH] Added repository layout in README. It needs more details. --- README | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 76 insertions(+), 1 deletion(-) diff --git a/README b/README index 7fb976fcf..6499479d3 100644 --- a/README +++ b/README @@ -97,6 +97,81 @@ Windows XP/7: 5) Now start Visual Studio and load the qgroundcontrol.vcproj if using Visual Studio 2008 or qgroundcontrol.vcxproj if using Visual Studio 2010 -6) Compile and edit in Visual Studio. If you need to add new files, add them to qgroundcontrol.pro and re-run `qmake -tp vc qgroundcontrol.pro` +6) Compile and edit in Visual Studio. If you need to add new files, add them to qgroundcontrol.pro and re-run `qmake -tp vc qgroundcontrol.pro + + +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 + testlog2.txt + user_config.pri - For custom message specs. +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. Agian 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 calibrartion. +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. -- 2.22.0