summaryrefslogtreecommitdiff
path: root/readme
blob: 24e00098f890bde85dcc68254cd4b91c2b7f9939 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
Hello! You must be new to all this so here's a rough breakdown of what is going on.

overview: http://gnusha.org/skdb/

to download packages:
    python clients/skdb-get.py lego
    python clients/skdb-get.py screw

Completed features:
- a simple example package describing a typical screw from the hardware store
  - the screw has a set of requirements for being manufactured
  - the package has a set of packages it needs to work right (threads package)
  - the package contains metadata such as homepage URL, author, copyright license
- run ~/.skdb/lego/demo.py to demonstrate interface compatibility
- run paths.py to demonstrate making a lego assembly
- generate an assembly graph via igraph

here is a break down of the current directory structure:

config.yaml
    you need to edit this

clients/
    front-ends for ordering parts. later there will be tools here for doing pretend scenarios, generating instructions, or assembling armies of giant robots

core/
    code needed for loading, parsing, and drawing inferences from package data

geom/
    optional code to work with pythonOCC/OpenCASCADE

gui/
    optional code to work with pythonOCC/wxPython (graphical user interface)

doc/
    instructions for how to use SKDB (maybe some day)

doc/BOMs
    miscellaneous "required materials" lists for different fields of study (half-baked)

doc/proposals
    pseudo-code used by the developers to bounce ideas off each other

icons/
    generic representations of manufacturing techniques. this will move soon

import_tools/
    command line scripts that are used to convert from external file formats and databases

inventory/
    (mostly web-based) tools for managing your personal inventory, searching for resources in other locations, and data about various specific facilities and their access policy

packages/
    sample SKDB packages defining a set of artifacts, processes and stuff you can do with them

tests/
    run these after hacking to make sure you didn't break anything

====

Links and learning more

homepage: http://gnusha.org/skdb/
git repository: http://diyhpl.us/cgit/skdb
email: openmanufacturing@googlegroups.com
IRC: ##hplusroadmap on irc.freenode.net