Create README.md

2023-04-06 18:34:35 +01:00
commit 0f3ede77fa
1 changed files with 38 additions and 0 deletions
@@ -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
+```
+
+
+
+