Skip to content

Commit

Permalink
Tweak docs a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
prescientmoon committed Nov 28, 2024
1 parent d6ba560 commit 3982ec6
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 21 deletions.
26 changes: 10 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

- Simple & intuitive UI
- (Parametrized) integrated circuits
- Multi-bit signals
- Multiple language support: Romanian, English, Dutch, Turkish, Chinese & more in the future

Check out the [demo](https://mateiadrielrafael.github.io/erratic-gate/)
Or read the [docs](./docs/main.md).
## Contributing

This repo provides a nix flake for deployment.

## Credits

Expand All @@ -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.
8 changes: 4 additions & 4 deletions docs/main.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion docs/tutorials/controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down

0 comments on commit 3982ec6

Please sign in to comment.