Skip to content

Commit 1339564

Browse files
authored
Update README.md
1 parent a91d097 commit 1339564

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This project is written in Python3.
88
> This project is work in progress. It is known that not all designs are generated correctly, so there are still some bugs.
99
1010

11-
Feel free to contribute, open issues, etc.
11+
Feel free to contribute, open issues, [work on existing issues](https://github.com/maehw/wokwi-lookup-table-generator/issues), etc.
1212
To contribute to the project, fork this GitHub repository and create a pull request. Detailed instructions can be found at https://docs.github.com/en/get-started/quickstart/contributing-to-projects. I'll be happy to review the code diff and eventually merge it into the original repo here.
1313

1414

@@ -37,33 +37,33 @@ Examples:
3737
Only specifying the input file name, will dump the wokwi schematic via `stdout`:
3838

3939
```
40-
python3 generate.py -f 2bit_half_adder.logic.json
40+
python3 generate.py -f ./demos/2bit_half_adder.logic.json
4141
```
4242

4343
Only specifying the input file name, will dump the wokwi schematic via `stdout` (piped to `/dev/null`), log level `DEBUG`:
4444

4545
```
46-
python3 generate.py -f 2bit_half_adder.logic.json -vv > /dev/null
46+
python3 generate.py -f ./demos/2bit_half_adder.logic.json -vv > /dev/null
4747
```
4848

4949
Specify an output file for the wokwi schematic:
5050

5151
```
52-
python3 generate.py -f 2bit_half_adder.logic.json -o 2bit_half_adder.diagram.json
52+
python3 generate.py -f ./demos/2bit_half_adder.logic.json -o 2bit_half_adder.diagram.json
5353
```
5454

5555
Specify an output file for the wokwi schematic externally but also show contents on `stdout` by [piping it through `tee`](https://en.wikipedia.org/wiki/Tee_(command)):
5656

5757
```
58-
python3 generate.py -f 2bit_half_adder.logic.json | tee 2bit_half_adder.diagram.json
58+
python3 generate.py -f ./demos/2bit_half_adder.logic.json | tee 2bit_half_adder.diagram.json
5959
```
6060

6161
Switches `-p` and `-c` allow to limit the dump to wokwi parts ony respectively wokwi connections only.
6262

6363
This feature can be used to modify existing designs only. The following command can be used on Mac OS X to **copy** the parts of the design into the **p**aste **b**uffer:
6464

6565
```
66-
python3 generate.py -f bcd_7segment_lut.logic.json -p | sed 's/[{}]//' | pbcopy
66+
python3 generate.py -f ./demos/bcd_7segment_lut.logic.json -p | sed 's/[{}]//' | pbcopy
6767
```
6868

6969

@@ -113,10 +113,12 @@ The author says:
113113
- perform sanity checks to see if all parts are connected,
114114
some may be unused due to bugs (probably rounding)
115115

116+
Some TODOs or ideas are already visible in the [issues tab](https://github.com/maehw/wokwi-lookup-table-generator/issues). Especially have a look at the issues labeled `good first issue` and `help wanted`.
117+
116118

117119
## Demo designs
118120

119-
For descriptions of the demo designs, inspect their JSON files.
121+
For descriptions of the demo designs, inspect their JSON files in the `./demos` subdirectory of this repo.
120122

121123
> **Warning**
122124
> The Quine McCluskey algorithm currently does not give deterministic results. An issue has been opened [here](https://github.com/tpircher/quine-mccluskey/issues/8).

0 commit comments

Comments
 (0)