aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2016-12-28 14:08:52 +0100
committerTrygve Laugstøl <trygvis@inamo.no>2016-12-28 14:08:52 +0100
commit117431b9511be07db8ce53526dbb985b5fad00a2 (patch)
treeabd48f2fec45184c45995d163fc7940cfeb4d423 /README.md
parentde8665b0b05db10c3257f9c645a09638a4732256 (diff)
downloadeda-rdf-117431b9511be07db8ce53526dbb985b5fad00a2.tar.gz
eda-rdf-117431b9511be07db8ce53526dbb985b5fad00a2.tar.bz2
eda-rdf-117431b9511be07db8ce53526dbb985b5fad00a2.tar.xz
eda-rdf-117431b9511be07db8ce53526dbb985b5fad00a2.zip
o Adding 'digikey-download-metadata' tool that downloads everything from Digi-Key. Should support writing directly to database.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/README.md b/README.md
index de1d761..20b2fc8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
+# Installing
+
+## From Git
+
+For development, set `dir` to `env`.
+
+ virtualenv -p python3 $dir
+ env/bin/pip install -r requirement.txt
+
+On Debian-based distributions you might need to have the `libdb-dev`
+package installed.
+
+To test the pip installation, use
+
+ env/bin/pip install . --upgrade --prefix $dir
+
+Then you can use this to play around with the application:
+
+ env/bin/eda-rdf
+
# Applications to implement
## Rules
@@ -21,7 +41,9 @@ o Download datasheets, IBIS model, SPICE model
# TODOs
-* Change the arg parser to always allow a '--db' argument that defaults to './.eda-rdf'
+* Change the arg parser to always allow a '--db' argument that
+ defaults to './.eda-rdf'
* Create an 'init' command similar to git init
-* Rename "schematic" to "project"? Schematic is .. schematic specific but many of the possible tools work on the BOM
+* Rename "schematic" to "project"? Schematic is .. schematic specific
+ but many of the possible tools work on the BOM
and/or on the PCB so 'project' is probably a better term.