warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Daniel Rojas 2020-06-28 15:22:59 +02:00
parent 6cf7178a9f
commit 0a42b350c8
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -26,9 +26,9 @@ _Note_: WireViz is not designed to represent the complete wiring of a system. It
## Installation
WireWiz requires the ```graphviz``` package as well as it's python bindings. Graphviz itself is installed using your regular package manager, e.g. ```apt-get install graphviz```. The Graphviz python bindings are automatically installed as dependencies by the install script.
WireWiz requires GraphViz to be installed in order to work. See the [GraphViz download page](https://graphviz.org/download/) for OS-specific instructions.
Installation of the WireWiz package and its python dependencies can be done using pip after cloning the repository:
Installation of the WireWiz package and its Python dependencies can be done using pip after cloning the repository:
```
git clone <repo url>
@ -38,14 +38,6 @@ pip3 install -e .
## Examples
### (re)building the example projects
If you would like to rebuild all of the included demos, examples and tutorials, use the ```build_examples.py``` script:
```cd src/wireviz
./build_examples.py
```
### Demo 01
[WireViz input file](examples/demo01.yml):
@ -96,6 +88,14 @@ Output file:
See the [tutorial page](tutorial/readme.md) for sample code,
as well as the [example gallery](examples/readme.md) to see more of what WireViz can do.
### (Re-)Building the example projects
If you would like to rebuild all of the included demos, examples and tutorials, use the ```build_examples.py``` script:
```cd src/wireviz
./build_examples.py
```
## Usage
```
@ -114,11 +114,13 @@ mywire.html HTML page with wiring diagram and BOM embedded
## Status
This is very much a [work in progress](TODO). Source code, API, syntax and functionality may change wildly at any time.
This is very much a [work in progress](https://github.com/formatc1702/WireViz/projects/1). Source code, API, syntax and functionality may change wildly at any time.
## Requirements
Developed and tested using Python 3.7; might not work with older Python versions. Ubuntu 18.04 LTS users in particular may need to separately install Python 3.7 or above, as that comes with Python 3.6 as the included system Python install.
Developed and tested using Python 3.7; might not work with older Python versions.
Ubuntu 18.04 LTS users in particular may need to separately install Python 3.7 or above, as that comes with Python 3.6 as the included system Python install.
## License