From ab585f46ce7f979e53a818060592f7aed1d9f81e Mon Sep 17 00:00:00 2001 From: jean-pierre charras Date: Tue, 29 Dec 2015 13:14:35 +0100 Subject: [PATCH] Update doc. --- Documentation/HOW_TO_CONTRIBUTE.txt | 51 ++++++------------------- Documentation/development/compiling.md | 8 ++-- Documentation/wxWidgets_patch_notes.txt | 9 ++--- 3 files changed, 18 insertions(+), 50 deletions(-) diff --git a/Documentation/HOW_TO_CONTRIBUTE.txt b/Documentation/HOW_TO_CONTRIBUTE.txt index 8ce4ae3a39..4e24dd1eda 100644 --- a/Documentation/HOW_TO_CONTRIBUTE.txt +++ b/Documentation/HOW_TO_CONTRIBUTE.txt @@ -1,56 +1,27 @@ Contribute to KiCad (under Linux) -------------------- -1) make sure you have all the dependencies of KiCad: - sudo apt-get install debhelper dpatch libx11-dev libglm-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 +1) make sure you have all the dependencies of KiCad and installed a copy + of kicad sources: + see /Documentation/development/compiling.md -2) initialize Bazaar: - bzr whoami "John Doe " - -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, +2) Read coding_style_policy.pdf, in /Documentation, and other docs. -5) create a local (branch) copy of the KiCad project - bzr branch ./kicad.bzr ./kicad.my_contrib +3) Modify/add source code in kicad sources -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 +4) Compile: + see compiling.md -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. +5) Repeat step 3 and 4 until satisfied. 9) Create a patch file: - cd kicad.my_contrib + if you added the file foo.cpp do so: + bzr add foo.cpp + Create the patch 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. - diff --git a/Documentation/development/compiling.md b/Documentation/development/compiling.md index 2a398198d5..9cfb203da7 100644 --- a/Documentation/development/compiling.md +++ b/Documentation/development/compiling.md @@ -189,7 +189,7 @@ following command: If you are contributing directly to the KiCad project on Launchpad, you can create a local branch on your machine by using the following command: - bzr branch lp:repo_to_branch + bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/product kicad_source If you prefer to use [GIT][] as you version control system, you can clone the KiCad mirror on Github using the following command: @@ -198,7 +198,7 @@ Github using the following command: Here is a list of source links: -Stable release archive: https://launchpad.net/kicad/4.0/4.0.0-rc1/+download/kicad-4.0.0-rc1.tar.xz +Stable release archive: https://launchpad.net/kicad/4.0/4.0.1/+download/kicad-4.0.1.tar.xz Development branch: https://code.launchpad.net/~kicad-product-committers/kicad/product @@ -208,7 +208,7 @@ Github mirror: https://github.com/KiCad/kicad-source-mirror To perform a full build on Linux, run the following commands: - cd kicad_source_tree + cd mkdir -p build/release mkdir build/debug # Optional for debug build. cd build/release @@ -304,7 +304,7 @@ currently known issues when building KiCad using MSYS2. ### 64-bit Package of Boost 1.59 ### {#ki_msys2_64bit_boost} The context library of the x86_64 package of Boost version 1.59 is broken and will cause KiCad -to crash. You must downgrade to version 1.47 by running the command: +to crash. You must downgrade to version 1.57 by running the command: pacman -U /var/cache/pacman/pkg/mingw-w64-x86_64-boost-1.57.0-4-any.pkg.tar.xz diff --git a/Documentation/wxWidgets_patch_notes.txt b/Documentation/wxWidgets_patch_notes.txt index 9b825de84f..fb877fbd60 100644 --- a/Documentation/wxWidgets_patch_notes.txt +++ b/Documentation/wxWidgets_patch_notes.txt @@ -1,12 +1,9 @@ --== notes about wxWidgets problems ==-- -Last Revised: 02-jul-2015 +Last Revised: 28-dec-2015 Kicad needs wxWidgets, the multi platform G.U.I toolkit. -use *only* wxWidgets ->= 3.0.1 On Windows ->= 3.0.2 on Linux (prevision versions have bugs which crash Kicad) ->= 3.0.2 on OSX (which need patches: see patches/wxwidgets-3.0.0_macosx_xxx) +use *only* wxWidgets >= 3.0.2 Known bug on Windows: Postscript printers print tracks like thin line. @@ -14,7 +11,7 @@ It happens only for PS drivers, and PDF printer. Other drivers (PCL for instance) work fine, so it is unlikely a bug inside Kicad/wxWidgets -On 3.0.2 Window version 64 bits: +Window version : The mirror mode gives a blank sheet. This is a bug in wxWidgets 3.0.2 wxWidgets 3.0.2 must be patched (see patches/wxWidgets-3.0.2-msw-dc-orientation-fix.patch) and rebuilt.