kicad/install.txt

/*****************************/
/***** English version *******/
/*****************************/

KiCad binaries exists for Linux and Windows (XP, 2000).
Files (schematic, boards, libraries) created on both systems are totally compatible.

== Used language: ==
Doc files are in french, but KiCad user interface is internationalized:
User interface is in English for most countries.
User interface is in you native language only if you run KiCad from a localized version of you operation system.
It is easy to add a new translation with poedit.
KiCad can use this translation without any change.
'poedit' is used to create the french (and many other) translations.
See http://poedit.sourceforge.net.
Contact me for more details.

== Installation from release archive ==
kicad-{year}{month}{day}.zip - archive with statically linked KiCad for Windows XP and 2000 (not Windows 98).
or
kicad-{year}{month}{day}.tar.bz2 - archive with statically linked KiCad for Linux.

Untar or unzip KiCad archive (this create the KiCad tree in the current directory).

=== Under Windows: ===
Goto C:\ or D:\ (or other prefered directory).
Examples are for an install on C:\.
Unzip archive kicad-{year}{month}{day}.zip
You must have created c:\kicad.
Windows executables are in c:\kicad\winexe.
The main program is kicad.exe and from it you can run other programs
(schematic editor - eeschema, pcb editor - pcbnew, utilities: cvpcb and gerbview).
I suggest you create a shortcut to c:\kicad\winexe\kicad.exe

=== Under Linux: ===
You do must have libc.so.6 (KiCad doesn't work with libc.so.5)
You must have the "root" rights.
goto /usr/local
Untar kicad-{year}{month}{day}.tar.bz2 by command
 tar -xjpf kicad-{year}{month}{day}.tar.bz2.
The main program is /usr/local/bin/kicad
If you use KDE, then you can copy the shortcut /usr/local/share/kicad/kicad.desktop
in <user home directory>/Desktop and use it to run kicad.

== 3D modeler wings3D: ==
(Usefull only if you plan to create 3D shapes for Printed board modules)
goto www.wings3d.org to have more details.
Pcbnew use the exported files in wrml (.wrl) format from wings3d (not the native .wings format).

== Documentation: ==
Currenty in different languages.
Interactive help in HTML format.

Source files (200 sheets) are in OpenOffice.org (www.openoffice.org) format and
can be obtained from kicad-doc-x.y.tar.bz2 archive (in doc_src directory).
Can be read, printed and/or modified with OpenOffice.org Writer.

== Windows KiCad tree: ==
kicad/bin - binaries (executable files).
kicad/doc/ - Various documentation.
kicad/doc/help - Interactive help.
kicad/share/demos - demos of schematic and printed boards.
kicad/share/internat - dictionaries for interface localization.
kicad/share/library - libraries for schematic.
kicad/share/modules - module libraries for printed boards.
kicad/share/modules/packages3d - many 3D shapes (.wrl and .wings
    format) for existing modules.
	files *.mod are the libraries,
	and files *.brd are printed board you can see with pcbnew
	files *.brd show the existing modules (and 3D shapes) in libraries. 

== Linux KiCad tree: ==
/usr/local/bin - binaries (executable files).
/usr/local/share/doc/kicad/ - Various documentation.
/usr/local/share/doc/kicad/help - Interactive help.
/usr/local/share/kicad/demos - demos of schematic and printed boards.
/usr/local/share/kicad/internat - dictionaries for interface localization.
/usr/local/share/kicad/library - libraries for schematic.
/usr/local/share/kicad/modules - module libraries for printed boards.
/usr/local/share/kicad/modules/packages3d - many 3D shapes (.wrl and .wings
    format) for existing modules.
	files *.mod are the libraries,
	and files *.brd are printed board you can see with pcbnew
	files *.brd show the existing modules (and 3D shapes) in libraries. 

Warning:
Do not change the KiCad tree, or the location of binary files,
or KiCad will **not** be able to found other KiCad files (configuration, libraries...)


/*******************************/
/***** version Francaise *******/
/*******************************/

Les executable kicad existent pour Linux et Windows (XP, 2000)
Les fichiers crees (Schematique, circuits imprimes, librairies) sous ces 2 systemes sont
totalement compatibles.

Installation a partir des archives
(toutes les 2 contiennent **tous** les executables):
kicad.zip
ou
kicad.tgz (s'il est disponible)

Le decompactage cree le repertoire kicad (et ses sous repertoires) a partir
du repertoire courant.

**Sous Windows:
se placer dans C:\ (ou D:\ ou tout disque et repertoire de son choix)
On supposera ici que l'on s'est plac<61> dans c:\
Decompacter kicad.zip
Cr<EFBFBD>er un raccourci vers c:\kicad\winexe\kicad.exe
On pourra alors lancer le gestionnaire de projets kicad.exe

Sous Linux
On se placera de pr<70>f<EFBFBD>rence en /usr/local
Il faudra sans doute aussi etre "root"
Decompacter kicad.tgz ou kicad.zip
  - kicad.tgz: faire tar zxvf <chemin de kicad.tgz>/kicad.tgz
  - kicad.zip (unzip <chemin de kicad.tgz>/kicad.zip). Il faudra alors dans ce
    cas rendre executable kicad, cvpcb, eeschema, gerbview et pcbnew:
	se placer dans /usr/local/kicad/linux et faire la commande chmod 755 nom_fichier
	pour ces 5 fichiers.
On lancera kicad par /usr/local/kicad/linux/kicad
Sous KDE on pourra copier /usr/local/kicad/linux/kicad.desktop sur le bureau
de KDE comme raccourci.

Installation du modeleur 3D wings3D pour cr<63>er les formes 3D des modules du PCB:
Il est fourni dans ..kicad/wings3d pour Windows et Linux.
Se reporter au site du cr<63>ateur pour tous d<>tails (www.wings3d.org)
Se reporter aussi a la doc de pcbnew pour la g<>n<EFBFBD>ration des fichiers 3d

Documentation:
L'impression de la documentation (environ 200 pages) peut se faire
sous OpenOffice (www.openoffice.org) (magnifique logiciel libre de traitement de texte).

Principaux repertoires de kicad:
kicad/winexe: executables sous windows (teste sous XP et 2000)
kicad/linux: executables sous linux (testes sous Mandrake 9.2 et 10.0)
kicad/library: fichiers libraires de composants schematiques
kicad/library/doc: fichiers documentation des composants schematiques (.pdf)
	(accessibles directement de la schematique si l'on a install<6C> acrobat ou Xpdf)
kicad/modules: fichiers de composants (modules) pour le circuit imprim<69>
kicad/modules/packages3d: fichiers de formes 3D des modules

kicad/demos: C'est toujours utile...
kicad/internat: dictionnaires des langues (actuellement anglais->francais) pour les menus
kicad/help: fichiers d'aides en ligne
kicad/help/doc_src: fichiers d'aides (doc source, 200 pages) sous OpenOffice,
	a lire avant de se plaindre.


Complements:
-En cas de difficult<6C>:
Un probl<62>me peut surgir pour kicad lors de la recherche des fichiers utiles
comme fichiers de config, librairies, dictionnaire anglais->fran<61>ais, docs...
Sous Windows:
	La recherche se fait l<> ou sont lus les executables.
	Il ne faut donc pas recopier les executables ailleurs que l<> ou ils sont.
	Toutefois, si cela ne marche pas, kicad cherche le repertoire c:\kicad
Sous linux:
	La recherche se fait sur /usr/local/kicad (installation conseill<6C>e),
	ou dans le chemin des executables si /usr/local/kicad n'est pas trouv<75>.

Uniquement en cas d'installation non standard (et en cas de difficult<6C>),
definir la variable d'environnement kicad = <chemin de kicad>
ex: kicad=/usr/local/cao/kicad