From 865d7a899e05b1e3cdaa51cbc19b6a2ff4f54eed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?King=20K=C3=A9vin?= Date: Wed, 23 Mar 2022 10:49:07 +0100 Subject: [PATCH] README: development moved to other file --- README.md | 81 ------------------------------------------------------- 1 file changed, 81 deletions(-) diff --git a/README.md b/README.md index 2cda4de..7c35594 100644 --- a/README.md +++ b/README.md @@ -5,84 +5,3 @@ purpose usage ===== - -requirements -============ - -to be able to generate the outputs you need following software: - -- rake: the central script taking care of generating the output files (Makefile is too cumbersome to parse files) -- [QEDA](http://qeda.org/): to generate footprints for the parts -- [Lepton EDA](https://github.com/lepton-eda/lepton-eda): for the schematic capture -- [pcb-rnd](http://repo.hu/projects/pcb-rnd/): for the board layout -the output generation is automatized. - -compiling -========= - -library -------- - -almost all of the symbols and footprints used in the schematic and board layout are defined in the [QEDA](http://qeda.org/) format and generated for the CAD software. -the `library` folder contains the QEDA parts definitions. - -to install QEDA using NPM from the official repository: -~~~ -sudo npm install -g qeda -~~~ - -to install QEDA from the sources: -~~~ -git clone https://github.com/qeda/qeda -cd qeda -npm install -sudo npm install --global -~~~ - -to generate the parts: -~~~ -rake library -~~~ - -this will use the parts definition (.yaml files) in the `library` to generate [gEDA gschem](http://wiki.geda-project.org/geda:gaf)/[Lepton EDA](https://github.com/lepton-eda/lepton-eda) symbols (.sym files) in the `geda/symbols` folder, and [coralEDA pcb-rnd](http://repo.hu/projects/pcb-rnd/) footprints (.lht files) in the `coraleda/subc` folder. - -only the QEDA parts in subfolders within `library` come from the [QEDA library](https://doc.qeda.org/library/), but the files are included in this project for simplicity and archiving purposes. -all other parts are custom and written for this project. - -schematic ---------- - -the `.sch` file is the schematic source file. -it has been drawn using [Lepton EDA](https://github.com/lepton-eda/lepton-eda). - -it uses standard symbols, and the ones in the `geda/symbols/` folder. -most symbols are generated by QEDA as described above. - -to export as pdf: -~~~ -rake print -~~~ - -BOM ---- - -to export the bill of material (as CSV): -~~~ -rake bom -~~~ - -board ------ - -the `.lht` file is the board layout source file. -it has been drawn using [coralEDA pcb-rnd](http://repo.hu/projects/pcb-rnd/). - -it uses the symbols from the `coraleda/subc/` folder. -most symbols are generated by QEDA as described above. -`oshw_logo.lht` is just the Open Source Hardware Logo. -it been generated from https://oshwlogo.cuvoodoo.info/. - -to export gerber files for PCB manufacturer (and photo preview + overview document): -~~~ -rake fabrication -~~~