You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This project is written in Python3.
8
8
> This project is work in progress. It is known that not all designs are generated correctly, so there are still some bugs.
9
9
10
10
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.
12
12
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.
13
13
14
14
@@ -37,33 +37,33 @@ Examples:
37
37
Only specifying the input file name, will dump the wokwi schematic via `stdout`:
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)):
56
56
57
57
```
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
59
59
```
60
60
61
61
Switches `-p` and `-c` allow to limit the dump to wokwi parts ony respectively wokwi connections only.
62
62
63
63
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:
64
64
65
65
```
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
67
67
```
68
68
69
69
@@ -113,10 +113,12 @@ The author says:
113
113
- perform sanity checks to see if all parts are connected,
114
114
some may be unused due to bugs (probably rounding)
115
115
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
+
116
118
117
119
## Demo designs
118
120
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.
120
122
121
123
> **Warning**
122
124
> 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