You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-18Lines changed: 32 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,15 @@ Bookings can be imported from text files (CSV), e.g. provided by your bank accou
16
16
I started `SimpleAccounting` around 2005, only for my personal use to manage accounts and balances of a small club.
17
17
In 2019, I met a colleague from another small club who was looking for a simple solution to get an overview of the balances of several logical and real accounts.
18
18
19
-
So I decided to rework my solution to make it usable for others and open source.
19
+
So, I decided to rework my solution to make it usable for others and open source.
20
20
21
21
## Naming
22
22
23
23
The name says it all. The software is as simple as possible.
24
24
25
-
It probably does not follow all rules and laws of double-entry accounting, e.g. the software does not protect accounting entries from changes. Instead it is explicitly possible to change existing entries.
25
+
It probably does not follow all rules and laws of double-entry accounting, e.g. the software does not protect accounting
26
+
entries from changes.
27
+
Instead it is explicitly possible to change existing entries.
26
28
The data is stored in readable XML format and can be changed manually.
27
29
An XSD document is available online and linked from the XML document which supports editing with code completion support.
28
30
@@ -31,27 +33,34 @@ The software focuses on journal and balance sheet reporting.
31
33
## Features
32
34
33
35
* Data management for double-entry accounting, stored as XML (see [example](./samples/sample.acml)) and defined using [XSD](./docs/AccountingData.xsd)
34
-
* User interface (English and German) for the management of accounts, the creation and modification of entries, the listing of account journals
36
+
* User interface (English, German, and French) for the management of accounts, the creation and modification of entries,
37
+
the listing of account journals
35
38
* Support for split booking entries, either on credit or debit side
36
39
* Import of booking entries from your bank account using CSV files incl. semi-automatic assignment of offsetting accounts
37
40
* Printable reports for full journal, account journal, accounts and balances, and annual financial statements
38
41
* Semi automatic update of the application
39
42
40
43
Some screenshots for first impression:
41
44
42
-
|Main view|Split booking|Totals and balances report|
43
-
|-|-|-|
44
-
|<imgsrc="./samples/MainView.png"alt="Main view"width="250" />|<imgsrc="./samples/SplitBooking.png"alt="Split booking"width="250" />|<imgsrc="./samples/TotalsAndBalancesReport.png"alt="Totals and balances report"width="250" />|
45
+
|Main view|Split booking|Totals and balances report|
|<imgsrc="./samples/MainView.png"alt="Main view"width="250" />|<imgsrc="./samples/SplitBooking.png"alt="Split booking"width="250" />|<imgsrc="./samples/TotalsAndBalancesReport.png"alt="Totals and balances report"width="250" />|
45
48
46
49
## Getting started
47
50
48
-
The application is based on [.NET Core 3](https://dotnet.microsoft.com/download/dotnet-core/3.1).
49
-
Please download and install the Runtime in version [3.1](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-desktop-3.1.16-windows-x64-installer) or above.
50
-
51
-
Please note, the "development version" (current main branch) is already on .NET 8.
52
-
New official release is pending.
53
-
54
-
Download the `SimpleAccounting` package from the [release page](https://github.com/lg2de/SimpleAccounting/releases).
51
+
The application is based on [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
52
+
There is
53
+
a [self-contained package](https://github.com/lg2de/SimpleAccounting/releases/download/2.3.0/SimpleAccounting-self-contained.zip)
54
+
available. Using this package you do not need to install the .NET 8 runtime. I'll update this package with security
55
+
fixes if needed.
56
+
There is also a [small package](https://github.com/lg2de/SimpleAccounting/releases/download/2.3.0/SimpleAccounting.zip)
57
+
available which requires .NET runtime to be installed.
58
+
Please download and install the Runtime in
59
+
version [8.0](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.0-windows-x64-installer)
60
+
or above.
61
+
62
+
Download one of the `SimpleAccounting` packages from
63
+
the [release page](https://github.com/lg2de/SimpleAccounting/releases).
55
64
Extract the ZIP archive into your preferred destination directory.
56
65
57
66
Start `SimpleAccounting.exe`.
@@ -60,12 +69,14 @@ Start `SimpleAccounting.exe`.
60
69
61
70
Contributions are welcome!
62
71
63
-
Small changes can be made immediately via Pull Request. I will try to check and integrate it as soon as possible.
64
-
Medium and large changes should be discussed first. Please open a new issue or participate in existing discussions.
72
+
Small changes can be made immediately via Pull Request.
73
+
I will try to check and integrate it as soon as possible.
74
+
Medium and large changes should be discussed first.
75
+
Please open a new issue or participate in existing discussions.
65
76
66
77
## TODOs
67
78
68
-
I am German and have no experience with English terms in the financial world.
79
+
I am German and have no experience with English or French terms in the financial world.
69
80
Therefore, I am pretty sure that some of the words I used are confusing for native speakers.
70
81
Perhaps you would like to help with better naming?
71
82
@@ -81,7 +92,10 @@ The roadmap is defined by issues and milestones.
81
92
I do not like closed source reuse of my software.
82
93
This is why I decided to license the software under GPLV3.
83
94
84
-
The application uses several external packages licened unter[MIT](https://opensource.org/licenses/MIT).
95
+
The application uses several external packages licensed under[MIT](https://opensource.org/licenses/MIT).
85
96
Additionally the package [CsvHelper](https://github.com/JoshClose/CsvHelper) is licensed from Josh Close under [MS-PL](https://opensource.org/licenses/MS-PL).
86
97
87
-
For the unit tests additional packages are used licensed under [Apache 2.0](https://licenses.nuget.org/Apache-2.0), [MS-PL](https://opensource.org/licenses/MS-PL), and [BSD-3-Clause](https://licenses.nuget.org/BSD-3-Clause).
98
+
For the unit tests additional packages are used licensed under
0 commit comments