diff --git a/README.md b/README.md index df9b2ee..6ff3678 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # 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/) -Or read the [docs](./docs/main.md). +- Simple & intuitive UI +- (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 @@ -14,15 +20,3 @@ Many thanks to: 1. [Canana](http://canana.xyz/) for the logo! 2. Player_0_1#2955 for all the testing and ideas 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. diff --git a/docs/main.md b/docs/main.md index a2f2742..9cd30d8 100644 --- a/docs/main.md +++ b/docs/main.md @@ -1,6 +1,6 @@ # Table of content: -- [Installation / Running guide](./tutorials/running.md) -- [Controls](./tutorials/controls.md) -- [The infoeducatie docs](./actual-docs.md) -- [Basic usage](./tutorials/sr-latch.md) +- [Installation / Running guide](./tutorials/installation.md) +- [Controls](./tutorials/controls.md) +- [The infoeducatie docs](./actual-docs.md) +- [Basic usage](./tutorials/sr-latch.md) diff --git a/docs/tutorials/controls.md b/docs/tutorials/controls.md index 3b9d13d..4ac9d73 100644 --- a/docs/tutorials/controls.md +++ b/docs/tutorials/controls.md @@ -3,7 +3,7 @@ # The controls | Action | Keybinding | Gui | -| :---------------------------------: | :---------------------: | :--------------------------------------------------------------------------: | +| :---------------------------------: | :---------------------: | :--------------------------------------------------------------------------: | ------------------------------------------------------ | | 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 `left mouse button` |