From 809544c572bd9cc3a3fd69f9eaad2fa3e6bc99ad Mon Sep 17 00:00:00 2001
From: Bogdan Cristea <cristeab@gmail.com>
Date: Sun, 30 Oct 2022 20:15:26 +0200
Subject: [PATCH] readme file

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index af47767..d55d496 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,25 @@
-EvidentaFiscala
+# FiscalRecords
+
+Application used to keep fiscal records in CSV files written in Qt/QML.
+The only supported language is Romanian.
+This is work in progress.
+
+# External dependences:
+
+- Qt v6.4
+
+- cmake v3.18
+
+- qtcsv v1.7 (https://github.com/iamantony/qtcsv.git)
+
+# Target Platforms
+
+- macOS
+
+- any other platform where Qt runs (planned)
+
+# Installer Generation
+
+- use the provided bash script to compile and generate the installer:
+
+    ./build-macos-release.sh