Merge pull request #4 from FOSSEE/develop

merging dev into master

1 files changed, 56 insertions, 0 deletions

diff --git a/Documentation/HOW_TO_CONTRIBUTE.txt b/Documentation/HOW_TO_CONTRIBUTE.txt
new file mode 100644
index 0000000..d042329
--- /dev/null
+++ b/Documentation/HOW_TO_CONTRIBUTE.txt
@@ -0,0 +1,56 @@
+Contribute to KiCad (under Linux)
+--------------------
+
+1) make sure you have all the dependencies of KiCad:
+    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
+
+2) initialize Bazaar:
+    bzr whoami "John Doe <john.doe@gmail.com>"
+
+3) get latest KiCad source tree:
+    cd ~/
+    bzr branch lp:kicad kicad.bzr
+
+   this should leave you with the folder kicad.bzr
+
+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
+    gedit .......
+   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
+
+7) Compile:
+    cd kicad.my_contrib
+    mkdir build; cd build
+    cmake ../ -DCMAKE_BUILD_TYPE=Debug
+   to build a debug version
+   or
+    cmake ../ -DCMAKE_BUILD_TYPE=Release
+   to build a release version
+    make -j8
+
+8) Repeat step 6 and 7 until satisfied.
+
+9) Create a patch file:
+    cd kicad.my_contrib
+    bzr diff  > my_changes.patch
+
+9) Send the patch file "my_changes.patch" to the KiCad developers mailing list.
+   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.
+