en:devel
Differences
This shows you the differences between two versions of the page.
Previous revision | |||
— | en:devel [2021/02/13 11:23] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | |||
+ | ====== Howto Contribute and Code ====== | ||
+ | |||
+ | If you wish to contribute to Actionaz, this page is for you. You find here some indications to help you with the first steps to be able to contribute to **actionaz**. | ||
+ | |||
+ | ====== Description of the development environment ====== | ||
+ | |||
+ | The source code of Actionaz project can be found on [[https:// | ||
+ | |||
+ | First, you have to duplicate the actionaz repository | ||
+ | |||
+ | After, you will configure your local development environment. | ||
+ | |||
+ | ===== GitHub Configuration ===== | ||
+ | |||
+ | Go to [[http:// | ||
+ | |||
+ | After, by searching // | ||
+ | |||
+ | When you access with your own GitHub account the repository of // | ||
+ | |||
+ | This operation takes only few seconds, and when it is over, you'll be redirected to your new home page of your project (the repository is called : **//< | ||
+ | |||
+ | For the GitHub part, the hardest is done, now we will install your local environment. | ||
+ | |||
+ | But, we describe only the installation part ... But a daily practicing of **Git/ | ||
+ | |||
+ | ===== Local Environment===== | ||
+ | |||
+ | ==== Ubuntu Case ==== | ||
+ | |||
+ | **Git** (inspired from : [[http:// | ||
+ | |||
+ | 1- Install git | ||
+ | <code bash> | ||
+ | $ sudo apt-get install git-core git-doc | ||
+ | </ | ||
+ | |||
+ | 2- Configure git | ||
+ | <code bash> | ||
+ | $ git config --global user.name " | ||
+ | $ git config --global user.email " | ||
+ | </ | ||
+ | |||
+ | Enable colors when outputting to terminal: | ||
+ | <code bash> | ||
+ | $ git config --global color.ui true | ||
+ | </ | ||
+ | |||
+ | 3- Generate Cryptographic keys [Be sure to have a passphrase ready] | ||
+ | <code bash> | ||
+ | $ ssh-keygen -t rsa -C " | ||
+ | </ | ||
+ | |||
+ | 4- Add Public Key to GitHub | ||
+ | |||
+ | Copy all contents of '' | ||
+ | |||
+ | 5- Tell SSH to use the new Key | ||
+ | <code bash> | ||
+ | $ ssh-add ~/ | ||
+ | </ | ||
+ | |||
+ | 6- Test connection to GitHub | ||
+ | <code bash> | ||
+ | $ ssh -T git@github.com | ||
+ | Hi < | ||
+ | </ | ||
+ | |||
+ | 7- Clone the repository and start coding | ||
+ | <code bash> | ||
+ | $ git clone git@github.com:< | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | **QT and minimum stuff to compile :** | ||
+ | |||
+ | 1- The required packages to compile the project | ||
+ | |||
+ | <code bash> | ||
+ | sudo apt-get install build-essential libqt4-dev qtmobility-dev libxtst-dev libnotify-dev libopencv-dev libboost-dev qtscript-tools | ||
+ | </ | ||
+ | |||
+ | 2- Installing QTcreator | ||
+ | |||
+ | It is not mandatory, but this tool give a lot of confort to the developper. It's up to you. | ||
+ | <code bash> | ||
+ | sudo apt-get install qtcreator | ||
+ | </ | ||
+ | |||
+ | 3- Howto respect the coding convention | ||
+ | |||
+ | For actionaz project, use Tab of 4 characters. In QTcreator go to the //Tools// entry of the main menu, then // | ||
+ | |||
+ | ==== Windows Case ==== | ||
+ | TODO | ||
+ | |||
+ | ===== Howto Compile Actionaz ? ===== | ||
+ | |||
+ | * Go in the directory containing the sources, then : | ||
+ | <code bash> | ||
+ | $ qmake -r | ||
+ | $ make | ||
+ | </ | ||
+ | * To compile messages in your own language : | ||
+ | <code bash> | ||
+ | $ make locale_release | ||
+ | </ | ||
+ | To translate strings in the source code, go to the page [[en: | ||
+ | * To launch your version of '' | ||
+ | <code bash> | ||
+ | $ ./actionaz | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | |||
+ | |||
+ | ===== Going to see the code ? ===== | ||
+ | |||
+ | Your development environment is ready ! We can go fight with the [[en: | ||
+ | |||
+ | The project coding-style is described [[en: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | Other languages for this page : [[fr: | ||