commit 0f3ede77fa5b24cea4bfecbdfc02f1889a34a4fa Author: hugh-unicenta <59798574+hugh-unicenta@users.noreply.github.com> Date: Thu Apr 6 18:34:35 2023 +0100 Create README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9206807 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# uniCenta oPos + +## Overview + +uniCenta oPos is an enterprise level point of sale system and it has the following feature set + +* Sales +* Inventory +* Customers +* Suppliers +* Employees +* Reporting + +It runs on the following operating systems + +* Windows +* Linux +* Mac osX + +Full details can be found here: https://unicenta.com + +## Before you start +Install mysql (version 5X supported) and create a schema called unicentaopos + +## Build and Run the appication +To get started, simply clone the repository and build the artifacts +### build the artifacts +``` +mvn clean package +``` +### run the application +``` +java -jar ./target/unicentaopos +``` + + + +