summaryrefslogtreecommitdiff
path: root/docs/README.rst
diff options
context:
space:
mode:
authorAldrik Ramaekers <aldrikboy@gmail.com>2025-08-10 14:38:09 +0200
committerAldrik Ramaekers <aldrikboy@gmail.com>2025-08-10 14:38:09 +0200
commit0327e06b59aa20dbfec137b2287b950b5cb84960 (patch)
tree468a884cc65647f2f6b980a97dd010c9d0470ef6 /docs/README.rst
parent7a29dfbc37f2440b7e5461e905651b25615d2d02 (diff)
refactors, comments, documentation
Diffstat (limited to 'docs/README.rst')
-rw-r--r--docs/README.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/README.rst b/docs/README.rst
new file mode 100644
index 0000000..2762bf1
--- /dev/null
+++ b/docs/README.rst
@@ -0,0 +1,40 @@
+.. _readme:
+
+===============================
+OpenBooks - Accounting software
+===============================
+
+Author: Aldrik Ramaekers <aldrik.ramaekers@gmail.com>
+
+The master is hosted on github: https://github.com/aldrik-ramaekers/open-books
+
+All documentation can be found inside the docs folder.
+
+1. Introduction
+---------------
+OpenBooks is a simple and portable accounting tool. This tool aims to be EU VAT Directive compliant and has country specific compliance, invoice keeping and tax reporting.
+
+What OpenBooks **can** do:
+
+- OpenBooks handles administration of invoices, expenses, receipts, contacts, projects, VAT rates and cost centers.
+- OpenBooks can export/email invoices in PDF, UBL and Peppol format.
+- OpenBooks can send and receive invoices over the Peppol network (using a locally run `Holodeck <https://holodeck-b2b.org/>`_ instance).
+- OpenBooks can create country specific tax reports and audit files (see supported countries list).
+
+What OpenBooks **can't** do:
+
+- Intrastat reporting
+- Sustainability Reporting (CSRD)
+- PoS Fiscalization
+- Submit tax and audit reports
+
+2. Supported countries
+----------------------
+This section lists all country specific implementations to be compliant. If the country you operate from is not listed below, some reporting requirements might not be handled by OpenBooks.
+
+- **The Netherlands**: Quarterly tax reports, Archiving (Peppol BIS 3.0).
+
+3. Dependencies
+---------------
+- ImGui 1.92.1
+- simclist 1.5 \ No newline at end of file