This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
projects:crazyflie:pc_utils:dev_guide [2012-03-24 11:18] macke created |
projects:crazyflie:pc_utils:dev_guide [2021-06-24 16:52] kimberly |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Installing ====== | + | <WRAP center round important 60%> |
+ | This page has deprecated and will be archived. Please go to [[https:// | ||
+ | </ | ||
+ | ====== PC utils development guide ====== | ||
+ | |||
+ | ===== Installing ===== | ||
+ | This guide will help you get up and started with working with and contributing code to the Crazyflie Python Client: Getting the source code, installing it in your home profile for testing and contributing them back, if wished, to the source repository. | ||
+ | |||
+ | ==== Getting the source code ==== | ||
+ | The sources for the Crazyflie Python client are hosted in a [[https:// | ||
+ | |||
+ | After forking the repository, you have a complete copy of the code and all its history on GitHub. You can clone this repository using Git: | ||
- | ===== Fedora ===== | ||
< | < | ||
- | sudo yum install qt-devel | + | git clone [[https:// |
</ | </ | ||
+ | |||
+ | Git will make a subdirectory in the directory that you execute the command in and clone the repository there. | ||
+ | |||
+ | ==== Installing the sources in your home profile ==== | ||
+ | When developing with the Crazyflie Python client, it is helpful to develop, run and test the code in a user profile rather than installing it with root permissions system-wide. This way you can test changes without needing to reinstall into root-owned directories. The best way to do this is to simply execute the Python client from its path where you're developing it. | ||
+ | |||
+ | However, you might want to install the client like a " | ||
+ | |||
+ | < | ||
+ | python setup.py install --user | ||
+ | </ | ||
+ | |||
+ | This installs the sources into your user profile (e.g. in ~/.local). If you want to be able to run the Python client, you can either execute it straight from the sources, or from the executable installed in your profile (e.g. ~/ | ||
+ | |||
+ | < | ||
+ | export PATH=$PATH: | ||
+ | </ | ||
+ | |||
+ | If you don't use the setup script, but want to be able to add the repository' | ||
+ | |||
+ | ==== Testing changes ==== | ||
+ | Now that everything' | ||
+ | |||
+ | ==== Contributing your changed code ==== | ||
+ | If you've tested your changes and everything' | ||
+ | |||
+ | < | ||
+ | git push | ||
+ | </ | ||
+ | |||
+ | The buttons on the top left left you compare the code you've written with Bitcraze' | ||
+ | |||
+ | ===== Coding standard ===== | ||
+ | Currently this code is pretty messy but it's being modified to follow [[http:// | ||