diff --git a/README.md b/README.md index c30cb9c..29def55 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,22 @@ ![Alt text](/assets/demo.gif) Vault GUI is a very small lightweight application designed to mimic a basic banking system. Its designed to replicate systems similar to those that you'd find at places like [mykidsbank](https://mykidsbank.org/). It allows you the freedom to manage the financial systems of your dreams, from admin accounts, user accounts, transactions, loans, interest, collateral. All in a easy to use application, just enter some basic information such as your MYSQL ip address, login information and let the application handle the rest. + +# 📦 Installation guide + +## EasyCompile +Easycompile is a small script for windows, linux, and macos that'll fetch the most up to date version of the application (master branch) and compile it locally. Downloading all neccarry components to compile the application +### 🪟Windows +``` +WIP +``` + +### 🐧Linux +``` +WIP +``` + +### 🍎Macos +``` +WIP +```