prescientmoon/erratic-gate
prescientmoon/erratic-gate
1
Fork 0
Code Issues2 Pull requests Activity

better docs

Browse source
This commit is contained in:
Matei Adriel 2019-08-01 21:57:05 +03:00
parent fddba4e55e
commit 1f26a599f6
12 changed files with 155 additions and 65 deletions

44
docs/tutorials/4-bit-adder.md
View file

@ -1,44 +0,0 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
# Building a 4 - bit adder:
0. To save the simulation press `ctrl + s` or click `Simulation` > `Save`. Save your progress after each step.
1. Create a new ic called `half-adder` (`Create simulation` > `Integrated circuit` > `Half adder`)
1. Add the following logic gates (`Logic gates` > the name of the gate):
- 2 buttons
- 2 light bulbs
- a XOR gate
- an AND gate
> You can get more info about these gates by clicking `Logic gates` > the <i class='material-icons'>info</i> icon at the rght of the gate.
3. To move a gate, drag & drop it with the right mouse button. To connect 2 pins, click once on each. Build the following configuration:
![Half adder](../assets/half-adder.png)
3. Create a new ic called `full-adder` (See step 1)
4. Add the following gates (See step 2):
- 3 buttons
- 2 light bulbs
- 2 half adders
- an OR gate
5) Build the following configuration (See step 3):
![Full adder](../assets/full-adder.png)
6) Create a new project called `4-bit-adder` (`Create simulation` > `Project` > `4-bit-adder`)
7) Add the following components (See step 2):
- 8 button
- 5 light bulbs
- 3 full adders
- 1 half adder
8) Build the following configuration (See step 3):
![4-bit-adder](../assets/4-bit-adder.png)
9) Enjoy!
Congratiulations! You've made your first circuit! With this simulator at your dispossal, the possibilities are endless! Here are a few things you can try and create yourself: - A 4-bit substractor - A counter - Different latches - If you are confident in you skills, you can even make a full 4-bit processor!

6
docs/tutorials/controls.md
View file

@ -6,7 +6,7 @@
| :---------------------------------: | :---------------------: | :--------------------------------------------------------------------------: |
| Save | `ctrl + s` | `Simulation` > `Save` |
| Add a gate | - | click `logic-gates` > the gate you want to add |
| Move a gate | - | drag & drop the gate using the `right mouse button` |
| Move a gate | - | drag & drop the gate using the `left mouse button` |
| Pan | - | click & move & release the background useing the `right mouse button` |
| Select multiple gates | - | click & move & release using the `left mouse button` |
| Add to selection | `shift` | select while holding `shift` |
@ -22,3 +22,7 @@
| Create integrated circuit | - | `Create simulation` > `Integrated circuit` > type the name of the simulation |
| Change language | - | Click on the `Language: \<language\>` button (bottom of the sidebar) |
| Get more info about a built in gate | - | `Logic gates` > <i class="material-icons">info</i> |
| Duplicate selection | `ctrl + d` | `Simulation` > `Duplicate selection` |
| Copy selection | `ctrl + c` | `Simulation` > `Copy` |
| Cut selection | `ctrl + x` | `Simulation` > `Cut` |
| Paste selection | `ctrl + v` | `Simulation` > `Paste` |

10
docs/tutorials/running.md → docs/tutorials/installation.md
View file

@ -38,17 +38,11 @@ To build the source run:
npm run build
```
To then run the simulation, open a server in the dist directory. A simple solution using npm:
To then run the simulation, use the start command:
```sh
# instal nano-server globally
npm i nano-server -g
# change directory
cd dist
# run server
nano-server
npm start
# linux
open http://localhost:5000