From 210a31e162b8b76dcc031adcc5186ad6fbff9bdc Mon Sep 17 00:00:00 2001
From: AR2000AR <AR2000AR@users.noreply.github.com>
Date: Sat, 13 Feb 2021 13:31:48 +0100
Subject: [PATCH] add README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0537d54
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# OpenComputers codes
+My lua programs for openComputers.
+
+---
+
+---
+## Banking system
+The bank is made of 2 main part : the server and a client. The client can be an ATM or a app to manage accounts.
+
+### Main apps
+#### bank_server
+The main server hosting every files needed for the system to work.
+
+### bank_dev_tools
+Add a simple command line program to edit the encrypted accounts info. Don't install it if you don't need it.
+
+### Librairy and API
+
+#### bank_api
+Enable the programs to make requests to the server.
+
+#### libCB
+Read and write credit card on an unmanaged floppy.
+
+#### libCoin
+move coins with a transposer. Use coins from the [ordinary coins](https://www.curseforge.com/minecraft/mc-mods/ordinary-coins) mod.  
+Note that the exchange rate is 50:1 instead of the default 100:1.
+
+---
+## Other programs
+
+### itemIdCatcher
+Write the item id of every items in the chest on top of the transposer in a file. Item are moved on the chest on the bottom once it's id is saved. The program stop after 3 loop without items in the chest.
+
+---
+## Additional librarys
+
+### libClass
+add object oriented programing to lua.
+
+### libGUI
+draw graphical element on screen. Use a widget system based on libClass.
+
+### libGUI
+Non essential widgets for libGUI.