summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b9f29c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+Logic gate simulator in C++ using FOX.
+
+![image](https://danieljon.es/media/foxlogicgates1.png)
+
+Click on an icon and left-click anywhere on the canvas to place that gate (or input/output).
+
+Select a gate by left-clicking on it and press delete to delete that gate and its links.
+
+Hold shift and left-click and drag a link to another gate to connect them.
+
+Click on a gates input to highlight that particular link, press the delete key to delete that link.
+
+Right-click on an input to toggle it on and off.
+
+# install
+You need the FOX toolkit installed. On arch install the 'fox' package.
+```
+cmake CmakeLists.txt
+make
+```
+The binary is in bin/