Skip to content

Commit 133c7ff

Browse files
Update README.md
1 parent fb32d82 commit 133c7ff

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A command-line tool and library for converting ASCII-art diagrams into beautiful
1010

1111
Turn this:
1212

13-
```txt
13+
```none
1414
*--BAT1+--*-------*---*
1515
| | | |
1616
| R1 .~~~. |
@@ -49,11 +49,28 @@ And with a little CSS, this:
4949

5050
Works with Python 3.10+. It uses the new `match` feature in a few places. If you need to run Schemascii on an older version of Python, feel free to fork it and send me a pull request.
5151

52-
Command line usage:
52+
## Installation
53+
54+
Not published to PyPI yet, so you have two options:
55+
56+
1. Install using pip's VCS support:
57+
```bash
58+
pip install git+https://github.com/dragoncoder047/schemascii
59+
```
60+
2. Install from source:
61+
```bash
62+
git clone https://github.com/dragoncoder047/schemascii
63+
cd schemascii
64+
pip install .
65+
```
66+
67+
You can also add `git+https://github.com/dragoncoder047/schemascii` to your `requirements.txt` if you have one.
68+
69+
## Command line usage
5370

5471
```usage
5572
usage: schemascii [-h] [-V] [-o OUT_FILE] [--padding PADDING] [--scale SCALE] [--stroke_width STROKE_WIDTH] [--stroke STROKE]
56-
[--label {L,V,VL}]
73+
[--label {L,V,VL}] [--nolabels]
5774
in_file
5875
5976
Render ASCII-art schematics into SVG.
@@ -72,9 +89,10 @@ options:
7289
Width of the lines
7390
--stroke STROKE Color of the lines.
7491
--label {L,V,VL} Component label style (L=include label, V=include value, VL=both)
92+
--nolabels Turns off labels on all components, except for part numbers on ICs.
7593
```
7694

77-
Python usage example:
95+
## Python usage
7896

7997
```python
8098
import schemascii
@@ -92,8 +110,19 @@ svg = schemascii.render("my_circuit.txt",
92110
scale=15,
93111
stroke_width=2,
94112
stroke="black",
95-
label="LV")
113+
label="LV",
114+
nolabels=False)
96115
# these are the defaults
97116
```
98117

118+
## Contributing Tips
119+
120+
Make sure you have an *editable* install, so you can edit and still be able to use the `schemascii` command to test it:
121+
122+
```bash
123+
pip uninstall schemascii
124+
cd path/to/your/schemascii/checkout
125+
pip install -e .
126+
```
127+
99128
<!-- https://realpython.com/pypi-publish-python-package/ -->

0 commit comments

Comments
 (0)