Tweak docs a bit
This commit is contained in:
parent
d6ba5609e8
commit
3982ec6e4f
26
README.md
26
README.md
|
@ -1,11 +1,17 @@
|
||||||
# Logic gate simulator
|
# Logic gate simulator
|
||||||
|
|
||||||
This is a logic gate simulator made for infoeducatie 2019.
|
This is a logic gate simulator I originally wrote for infoeducatie 2019. Check out the [online instance](https://erratic-gate.moonythm.dev/).
|
||||||
|
|
||||||
## Getting started
|
## Features
|
||||||
|
|
||||||
Check out the [demo](https://mateiadrielrafael.github.io/erratic-gate/)
|
- Simple & intuitive UI
|
||||||
Or read the [docs](./docs/main.md).
|
- (Parametrized) integrated circuits
|
||||||
|
- Multi-bit signals
|
||||||
|
- Multiple language support: Romanian, English, Dutch, Turkish, Chinese & more in the future
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
This repo provides a nix flake for deployment.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
|
@ -14,15 +20,3 @@ Many thanks to:
|
||||||
1. [Canana](http://canana.xyz/) for the logo!
|
1. [Canana](http://canana.xyz/) for the logo!
|
||||||
2. Player_0_1#2955 for all the testing and ideas
|
2. Player_0_1#2955 for all the testing and ideas
|
||||||
3. BlueGhost, Vyctor661, Mao for all the design reviews
|
3. BlueGhost, Vyctor661, Mao for all the design reviews
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Simple & intuitive UI
|
|
||||||
- Multiple simulations support
|
|
||||||
- (Configurable) integrated circuits
|
|
||||||
- Multiple bits per pin
|
|
||||||
- Multiple language support: Romanian, English, Dutch, Turkish, Chinese & more in the future
|
|
||||||
|
|
||||||
## Playing with the source
|
|
||||||
|
|
||||||
This repo provides a nix flake for deployment.
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Table of content:
|
# Table of content:
|
||||||
|
|
||||||
- [Installation / Running guide](./tutorials/running.md)
|
- [Installation / Running guide](./tutorials/installation.md)
|
||||||
- [Controls](./tutorials/controls.md)
|
- [Controls](./tutorials/controls.md)
|
||||||
- [The infoeducatie docs](./actual-docs.md)
|
- [The infoeducatie docs](./actual-docs.md)
|
||||||
- [Basic usage](./tutorials/sr-latch.md)
|
- [Basic usage](./tutorials/sr-latch.md)
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
# The controls
|
# The controls
|
||||||
|
|
||||||
| Action | Keybinding | Gui |
|
| Action | Keybinding | Gui |
|
||||||
| :---------------------------------: | :---------------------: | :--------------------------------------------------------------------------: |
|
| :---------------------------------: | :---------------------: | :--------------------------------------------------------------------------: | ------------------------------------------------------ |
|
||||||
| Save | `ctrl + s` | `Simulation` > `Save` |
|
| Save | `ctrl + s` | `Simulation` > `Save` |
|
||||||
| Add a gate | - | click `logic-gates` > the gate you want to add |
|
| Add a gate | - | click `logic-gates` > the gate you want to add |
|
||||||
| Move a gate | - | drag & drop the gate using the `left mouse button` |
|
| Move a gate | - | drag & drop the gate using the `left mouse button` |
|
||||||
|
|
Loading…
Reference in a new issue