From 942186dc31d1e263b4868ed66d4d7322c4d3d3df Mon Sep 17 00:00:00 2001 From: David Date: Mon, 9 Jun 2014 20:40:37 -0400 Subject: [PATCH] Small updates to README --- README.md | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1778b99..b4304cc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,23 @@ Quadcopter Dynamic Modeling and Simulation (Quad-Sim) v1.00 ======= -TO DOWNLOAD: Click "Download Zip" on the right to download all of our materials as a single file. +Overview += +TO DOWNLOAD: Click "Download ZIP" on the right to download all of our materials as a single file. -Provided here is an assortment of materials designed to assist users in modeling and simulation a quadcopter. +A YouTube video providing a brief overview of our project was created for the 2014 MATLAB and Simulink Student design challenge. This video can be viewed at: + +http://youtu.be/kIgwZFGlgio + + +Copyright (C) 2014 D. Hartman, K. Landis, M. Mehrer, S. Moreno, J. Kim + +Contact: += +Please email reasonable questions, suggestions, and complaints to: + +DCHEngr@gmail.com + +Provided here is an assortment of materials designed to assist users in modeling and simulation of a quadcopter. Specifically: •Test rig designs for component performance measurement @@ -14,32 +29,35 @@ Specifically: •And a bit more stuff… -The full package should be available for download at: github.com/dch33/Quad-Sim +The full package should be available for download at: + +https://github.com/dch33/Quad-Sim + These materials are partially the result of a Senior Design project at Drexel University. The team consisted of: D. Hartman, K. Landis, M. Mehrer, S. Moreno, and J. Kim. +Our faculty advisor was Dr. B. C. Chang As this is our first attempt at a public release of our materials, there are undoubtedly errors, omissions, and downright lies contained herein. Expect frequent updates as we find and correct issues. We do not claim to be experts. All of our materials are provided simply as a service to the multi-rotor community in sincere hope that it will prove useful as a basis for further inquiry. Users are -expected to reference our materials against other more reliable sources, and use their best judgment or +expected to reference our materials against more reliable sources, and use their best judgment or consult professional advice where appropriate, particularly where safety may be a concern. Quadcopters and RC vehicles are dangerous and are not toys. Use caution and follow all manufacturer safety instructions. -That said, we hope you find these materials helpful. Good luck. +That said, we hope you find these materials helpful. Good luck! GENERAL INSTRUCTIONS === -Contained herein is documentation and instructions pertaining to specific tasks. -A good starting point is to take a look at what materials are provided within these documents. -In general, it is advisable to add all of the MATLAB and Simulink related folders +We provide documentation and instructions related to quadcopter dynamic modeing and simulation for control design. +A good starting point is to take a close look at what materials are provided within these documents, and see how it fits into your project needs. +In general, it would be advisable to add all of the MATLAB and Simulink related folders to the MATLAB path so that they can be easily accessed within the MATLAB environment. - -Copyright (C) 2014 D. Hartman, K. Landis, M. Mehrer, S. Moreno, J. Kim +Once you understand what we provide, you can tackle the materials in any order, or split up tasks among a team. Generally speaking, the order of tasks should be fairly self evident, and to some degree flexible depending on the needs of your project and your available resources. License Notice ===