From fafecb491e13406789423081e15448e2967c1cf5 Mon Sep 17 00:00:00 2001 From: jean-pierre charras Date: Thu, 14 Feb 2013 18:57:12 +0100 Subject: [PATCH] Remove outdated (and/or erroneous) documentation. --- Documentation/compiling/linux-debian.txt | 250 ----------------------- Documentation/compiling/linux-fedora.txt | 29 --- Documentation/compiling/linux-gentoo.txt | 99 --------- 3 files changed, 378 deletions(-) delete mode 100644 Documentation/compiling/linux-debian.txt delete mode 100644 Documentation/compiling/linux-fedora.txt delete mode 100644 Documentation/compiling/linux-gentoo.txt diff --git a/Documentation/compiling/linux-debian.txt b/Documentation/compiling/linux-debian.txt deleted file mode 100644 index b0625822b9..0000000000 --- a/Documentation/compiling/linux-debian.txt +++ /dev/null @@ -1,250 +0,0 @@ -Compiling KiCad on Debian & Ubuntu -================================== - -First written: 10-Mar-2009 - -Updated: 01-Oct-2009 - -Lasted edited by: Jerry Jacobs - - -Ubuntu 9.04 ------------ -Special thanks to David J S Briscoe - -The first thing I did was follow this page up to the running kicad section - -http://basicubuntu.blogspot.com/2009/02/installing-kicad-on-ubuntu.html - -This resulted in the error message detailed in this post - -http://tech.groups.yahoo.com/group/kicad-devel/message/3180 - -SNIPPET - -The build fails with the following message - -----------------------------------------------------------: - -david@ubuntu:~/Desktop/KICAD_SVN$ fakeroot debian/rules binary -test -d debian/patched || install -d debian/patched -dpatch apply-all -dpatch cat-all >>patch-stampT -mv -f patch-stampT patch-stamp -mkdir -p /home/david/Desktop/KICAD_SVN/build/kicad -mkdir -p /home/david/Desktop/KICAD_SVN/build/bitmaps -cd /home/david/Desktop/KICAD_SVN/build/kicad && cmake \ - --DKICAD_DEMOS=/home/david/Desktop/KICAD_SVN/debian/kicad-common/usr/share/doc/ki\ -cad/demos ../../kicad \ --DXPM_CPP_PATH=/home/david/Desktop/KICAD_SVN/build/bitmaps --- The C compiler identification is GNU --- The CXX compiler identification is GNU --- Check for working C compiler: /usr/bin/gcc --- Check for working C compiler: /usr/bin/gcc -- works --- Detecting C compiler ABI info --- Detecting C compiler ABI info - done --- Check for working CXX compiler: /usr/bin/c++ --- Check for working CXX compiler: /usr/bin/c++ -- works --- Detecting CXX compiler ABI info --- Detecting CXX compiler ABI info - done --- Looking for XOpenDisplay in /usr/lib/libX11.so;/usr/lib/libXext.so --- Looking for XOpenDisplay in /usr/lib/libX11.so;/usr/lib/libXext.so - found --- Looking for gethostbyname --- Looking for gethostbyname - found --- Looking for connect --- Looking for connect - found --- Looking for remove --- Looking for remove - found --- Looking for shmat --- Looking for shmat - found --- Looking for IceConnectionNumber in ICE --- Looking for IceConnectionNumber in ICE - found --- Found X11: /usr/lib/libX11.so --- Check for installed OpenGL -- found --- Check for installed Boost -- not found -CMake Error at CMakeModules/CheckFindPackageResult.cmake:6 (message): -Boost was not found - it is required to build Kicad -Call Stack (most recent call first): -CMakeLists.txt:111 (check_find_package_result) - - --- Configuring incomplete, errors occurred! -make: *** [configure-stamp] Error 1 -david@ubuntu:~/Desktop/KICAD_SVN$ - ------------------------------------------------------------------: - - -SNIPPET - -The next step was to remove any libboost 1.34 libraries using the apt-get -remove command (can't remember the exact commands I used) as the Ubuntu 9.04 -(Jaunty) repositories only had the 1.34 version available. - -After this I installed the boost 1.37 libraries -using this command - ---------------------------------------- -sudo apt-get install libboost1.37-dev ---------------------------------------- - -This pulled down all the required files and dependencies (as far as I -know-how do I check this?) - -I then entered the following command - ---------------------------------------- -fakeroot debian/rules binary ---------------------------------------- - -and everything was built properly (I saw a few warnings flash past-will -these be logged anywhere?) - -I was left with a bunch of debian packaged files. I installed the main one, -the common one and an English language documentation one (I can supply more -details if needed later as I am not using Ubuntu at the moment). - -The first link above describes moving the libraries and other files into the -same place as the compiled executables. I didn't do this, so I have a -duplicate installation. -The above method needs some fine tuning and improvements. If you can let me -know of a tidier way of compiling Kicad please let me know. -Maybe there is a way of automating things with scripts, my Linux knowledge -doesn't go that far, yet. - - -Ubuntu (8.04) -------------- -Original from: -http://basicubuntu.blogspot.com/2009/02/installing-kicad-on-ubuntu.html - -Required software and dependencies -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -We need to install the following packages: debhelper, dpatch, libx11-dev, -libglu1-mesa-dev, libgl1-mesa-dev, mesa-common-dev, libwxbase2.8-dev, -libwxgtk2.8-dev, libboost-dev, subversion, cmake (>= 2.6.0). - ---------------------------------------- -sudo apt-get install debhelper dpatch libx11-dev libglu1-mesa-dev -libgl1-mesa-dev mesa-common-dev libwxbase2.8-dev libwxgtk2.8-dev -libboost-dev fakeroot subversion libboost-serialization-dev ---------------------------------------- - -And finally, we need cmake, but we need atleast version 2.6, the one -from the repository is not the updated one (atleast for ubuntu 8.04). -You can download version 2.6 from newer ubuntu releases. -Just search for cmake on http://packages.ubuntu.com then get a newer -cmake .deb file and install the downloaded package on the console -with: - ---------------------------------------- -sudo dpkg -i ---------------------------------------- - -But if what the repository gives you is atleast version 2.6, then -simply - ---------------------------------------- -sudo apt-get install cmake ---------------------------------------- - -Get KiCad Sourcecode -~~~~~~~~~~~~~~~~~~~~ -We will be getting the source codes through subversion. Create a directory -where you'll be downloading the source codes, and go to that -directory. type the following: - ---------------------------------------- -svn checkout https://kicad.svn.sourceforge.net/svnroot/kicad/trunk/kicad kicad -svn checkout https://kicad.svn.sourceforge.net/svnroot/kicad/trunk/kicad-doc kicad-doc -svn checkout https://kicad.svn.sourceforge.net/svnroot/kicad/trunk/kicad-library kicad-library ---------------------------------------- - -Also we need the following to get the debian specific stuff - ---------------------------------------- -svn checkout http://svn.flexserv.de/kicad/trunk/debian ---------------------------------------- - -Compiling -~~~~~~~~~ -To compile simply do the following on your terminal (make sure you're still in -the same directory where you did the svn) - ---------------------------------------- -fakeroot debian/rules binary ---------------------------------------- -hopefully, there will be no errors. -You'll find the compiled version of KiCad in the following directory: - ---------------------------------------- -debian/kicad/usr/bin/ ---------------------------------------- -to complete things up, you'll need to copy the following folders - ---------------------------------------- -debian/kicad-common/usr/share/kicad/library -debian/kicad-common/usr/share/kicad/modules -debian/kicad-common/usr/share/kicad/template ---------------------------------------- -in here - ---------------------------------------- -debian/kicad/usr/share ---------------------------------------- -again, to run KiCad go to - ---------------------------------------- -cd debian/kicad/usr/bin/ ---------------------------------------- -and double click KiCad - - -Debian squeeze (testing) ------------------------- - -Special Note -~~~~~~~~~~~~ -After SVN trunk revision 1753 boost library 1.36 or higher is needed -to compile KiCad. - -Installing Packages -~~~~~~~~~~~~~~~~~~~ -The following packages should be installed with -synaptic, apt-get or aptitude: -- build-essential -- cmake -- libboost-dev -- libwxgtk2.8-dev -- libglut3-dev - -The following packages will also be installed then -- cmake dependencies -- boost development dependencies -- wxwidgets development dependencies -- opengl3 (glut) development dependencies - -Get KiCad sourcecode -~~~~~~~~~~~~~~~~~~~~ -Checkout sourcecode using subversion or download latest release. - -.*Subversion* ---------------------------------------- -svn checkout https://kicad.svn.sourceforge.net/svnroot/kicad/trunk/kicad kicad ---------------------------------------- - -.*Release* ---------------------------------------- -wget http://iut-tice.ujf-grenoble.fr/cao/kicad-sources-2009-02-16.tar.gz -tar -xvf kicad-sources-2009-02-16.tar.gz ---------------------------------------- - -Compiling -~~~~~~~~~ -Run 'cmake .' in the root of the source directory then build the -binaries with 'make'. - -Installing -~~~~~~~~~~ -For installing you could use 'make install' or build a debian package. diff --git a/Documentation/compiling/linux-fedora.txt b/Documentation/compiling/linux-fedora.txt deleted file mode 100644 index 4f7ed6322e..0000000000 --- a/Documentation/compiling/linux-fedora.txt +++ /dev/null @@ -1,29 +0,0 @@ -Compiling KiCad on Fedora -========================= - -First written: 2011-03-09 - -Lasted edited by: Jerry Jacobs - -Fedora 14 ---------- - -First we need to install all the needed tools and libraries with yum. First -become root with su. - -Then invoke yum: -yum install gcc gcc-c++ bzr cmake doxygen wxGTK-devel make - -Create somewhere on your drive a kicad directory. - -Then clone the bzr repository: -bzr checkout lp:kicad testing - -then cd into the build directory -invoke cmake to generate the makefiles - -cmake ../testing - -If everything went well you should be able to build kicad with make. - -make diff --git a/Documentation/compiling/linux-gentoo.txt b/Documentation/compiling/linux-gentoo.txt deleted file mode 100644 index 5f95864c0c..0000000000 --- a/Documentation/compiling/linux-gentoo.txt +++ /dev/null @@ -1,99 +0,0 @@ -Compiling KiCad on Gentoo -========================= - -Information ------------ -First written: 02-Mar-2010 - -Written by: calchan at gentoo dot org - - -For regular users ------------------ - -In order to install Kicad from sources in Gentoo you just need to: ----- - # emerge kicad ----- -The package manager will resolve all dependencies, download the -necessary source code, and then configure it, compile it and install -it. You're done. - -If you want to fine-tune your installation you can set some of the USE -flags. Do the following to see them: ----- - # emerge -vp kicad ----- -The currently available USE flags are: -debug: make a debug build -doc: install documentation -examples: install examples -python: enable python -minimal: do not install the default component libraries (unsupported) - -Enable or disable whatever USE flag(s) you want or don't want, for -example like this: ----- - # echo "sci-electronics/kicad doc -python" >> /etc/portage/package.use ----- -Here we've just enabled documentation and disabled python. After that -you can emerge kicad. - - -For advanced users ------------------- -If you're running stable gentoo and want the unstable (more recent) -version of kicad then do the following before running emerge: ----- - # echo "sci-electronics/kicad ~arch" >> /usr/portage/package.keywords ----- -where ~arch is either ~amd64, ~ppc, ~ppc64 or ~x86 depending on your -architecture. - -If you want to experiment with cmake flags to pass for compilation or -override one that's set by default in the ebuild you can do so like -this: ----- - # MYCMAKEARGS="-DUSE_WX_GRAPHICS_CONTEXT=ON" emerge kicad ----- - - -For Kicad developers and packagers ----------------------------------- - -You can install from live sources instead of the latest package -version by doing the following: ----- - # echo "sci-electronics/kicad **" >> /etc/portage/package.keywords - # emerge kicad ----- -The version of Kicad that is going to be installed is called -kicad-99999999. The package manager will then checkout all sources -from the subversion repository, or update it to the latest revision if -you had already installed the live version of Kicad, and then do its -usual thing. You will get an additional USE flag called dev-doc which -is to set if you want to build the Doxygen documentation. - -If you want to build a specific revision of Kicad from the subversion -repository, you can do: ----- - # ESVN_REVISION="2400" emerge kicad ----- -Note that you can combine that with MYCMAKEARGS on the same command-line. - -If you have built and tested Kicad and want to package it, it's very simple: ----- - # quickpkg kicad ----- -This works for both live and standard installs of Kicad. The tarball -will be in /usr/portage/packages. - -Here is one way to find out which packages contain the shared -libraries Kicad was built against, and what exact version they are: ----- - # equery belongs $(cat /var/db/pkg/sci-electronics/kicad-99999999/NEEDED | cut -d ' ' -f 2 | tr ',' '\n' | sort -u) | sort -u ----- -You should replace kicad-99999999 with the version you have just -built. You might want to be careful with the interpretation of the -results from the above one-liner, but if you made it this far you -obviously know what you're dealing with.