Skip to content

Commit aab9a0e

Browse files
authored
Update README.md
1 parent a6f1698 commit aab9a0e

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Logic Circuit Simulator
2-
A simple logic circuit simulator made with p5.js library.
2+
A logic circuit simulator made with [p5.js library](https://github.com/processing/p5.js), useful for educational use. It can be used for simulate combinational and sequential circuits.
33

44
### Demo live
55
A live version is available [here](https://drendog.github.io/Logic-Circuit-Simulator/).
66

77
## Usage
8+
89
### Demo
10+
911
![](demo.gif)
1012

1113
### Tools
14+
1215
![](simulator/img/pencil.svg) Edit - Move the components - Connect wires
1316

1417
![](simulator/img/hand.png) Move the whole circuit
@@ -19,37 +22,45 @@ A live version is available [here](https://drendog.github.io/Logic-Circuit-Simul
1922

2023
![](simulator/img/LogicOutput.png) Logic Output
2124

22-
## Built With
23-
* HTML
24-
* Javascript
25-
* [p5js](https://github.com/processing/p5.js) library.
26-
2725
## Set up for offline work
26+
2827
### Prerequisites
29-
* [Nodejs](https://nodejs.org)
28+
29+
* [Nodejs](https://nodejs.org) or some local web server ([more info](https://github.com/processing/p5.js/wiki/Local-server))
3030
* git
3131
```bash
3232
sudo apt-get install git
3333
```
3434

3535
### Clone the repository
36+
3637
```bash
3738
git clone https://github.com/drendog/Logic-Circuit-Simulator.git
3839
```
3940

4041
### Serve it on local
42+
4143
```bash
4244
cd Logic-Circuit-Simulator
4345
npx serve
4446
```
47+
48+
## :book: Reference book
49+
50+
Hamacher, C., Vranesic, Z., Zaky, S., & Manjikian, N. (2011). Appendix A. In *Computer Organization and Embedded Systems* (6th ed., p. 465). McGraw-Hill Education.
51+
4552
## 🤝 Contributing
53+
4654
Contributions, issues and feature requests are welcome.
4755

48-
## TODO
49-
Everything 🙃.
56+
## :wrench: TODO
57+
58+
Code documentation and everything.
5059

5160
## Author
52-
👤 **[DesrevernU/drendog](https://github.com/drendog)**
61+
62+
👤 **[drendog](https://github.com/drendog)**
5363

5464
## License
65+
5566
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)