HOW_TO_CONTRIBUTE.txt 1.53 KB
Newer Older
1 2 3 4
Contribute to KiCad (under Linux)
--------------------

1) make sure you have all the dependencies of KiCad:
5 6 7 8 9
    sudo apt-get install debhelper dpatch libx11-dev
    sudo apt-get install libglu1-mesa-dev libgl1-mesa-dev mesa-common-dev
    sudo apt-get install libwxbase2.8-dev libwxgtk2.8-dev libboost-dev fakeroot
    sudo apt-get install cmake bzr
    sudo apt-get install cmake bzr bzrtools
10 11

2) initialize Bazaar:
12
    bzr whoami "John Doe <john.doe@gmail.com>"
13

14
3) get latest KiCad source tree:
15
    cd ~/
16
    bzr branch lp:kicad kicad.bzr
17

18
   this should leave you with the folder kicad.bzr
19

20 21 22 23 24 25 26 27
4) Read coding_style_policy.pdf, in kicad.bzr/Documentation,
   and other docs.

5) create a local (branch) copy of the KiCad project
    bzr branch ./kicad.bzr ./kicad.my_contrib

6) Modify/add source code in
    cd kicad.my_contrib
28
    gedit .......
29 30 31 32
   if you need to create and add the file foo.cpp do so and:
    bzr add foo.cpp
   if you need to delete files:
    bzr rm foo.cpp
33

34 35
7) Compile:
    cd kicad.my_contrib
36
    mkdir build; cd build
37
    cmake ../ -DCMAKE_BUILD_TYPE=Debug
38 39
   to build a debug version
   or
40
    cmake ../ -DCMAKE_BUILD_TYPE=Release
41 42
   to build a release version
    make -j8
43

44
8) Repeat step 6 and 7 until satisfied.
45

46 47
9) Create a patch file:
    cd kicad.my_contrib
48
    bzr diff  > my_changes.patch
49

50
9) Send the patch file "my_changes.patch" to the KiCad developers mailing list.
51 52 53 54 55 56
   in the subject of the e-mail include the keyword "[PATCH]".
   in the body of the e-mail clearly explain what you have done.


for more info see INSTALL.txt.