From b94611b9487169b17dba842d5fab8810c920b03b Mon Sep 17 00:00:00 2001 From: Patrick Nagurny Date: Fri, 19 Oct 2018 15:32:17 -0400 Subject: [PATCH] readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf6f71b --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Open Accounting Server + +## Prerequisites + +1. Go 1.8+ +2. MySQL 5.7+ + +## Database setup + +Use schema.sql and indexes.sql to create a MySQL database to store Open Accounting data. + +## Configuration + +Copy config.json.sample to config.json and edit to match your information. + +## Run + +`go run core/server.go` + +## Build + +`go build core/server.go`