Skip to content

Commit fd5cec8

Browse files
committed
Update readme and license info for V2.3
1 parent 0c86662 commit fd5cec8

3 files changed

Lines changed: 34 additions & 20 deletions

File tree

README.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ Bookings can be imported from text files (CSV), e.g. provided by your bank accou
1616
I started `SimpleAccounting` around 2005, only for my personal use to manage accounts and balances of a small club.
1717
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.
1818

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.
2020

2121
## Naming
2222

2323
The name says it all. The software is as simple as possible.
2424

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.
2628
The data is stored in readable XML format and can be changed manually.
2729
An XSD document is available online and linked from the XML document which supports editing with code completion support.
2830

@@ -31,27 +33,34 @@ The software focuses on journal and balance sheet reporting.
3133
## Features
3234

3335
* 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
3538
* Support for split booking entries, either on credit or debit side
3639
* Import of booking entries from your bank account using CSV files incl. semi-automatic assignment of offsetting accounts
3740
* Printable reports for full journal, account journal, accounts and balances, and annual financial statements
3841
* Semi automatic update of the application
3942

4043
Some screenshots for first impression:
4144

42-
|Main view|Split booking|Totals and balances report|
43-
|-|-|-|
44-
|<img src="./samples/MainView.png" alt="Main view" width="250" />|<img src="./samples/SplitBooking.png" alt="Split booking" width="250" />|<img src="./samples/TotalsAndBalancesReport.png" alt="Totals and balances report" width="250" />|
45+
| Main view | Split booking | Totals and balances report |
46+
|------------------------------------------------------------------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
47+
| <img src="./samples/MainView.png" alt="Main view" width="250" /> | <img src="./samples/SplitBooking.png" alt="Split booking" width="250" /> | <img src="./samples/TotalsAndBalancesReport.png" alt="Totals and balances report" width="250" /> |
4548

4649
## Getting started
4750

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).
5564
Extract the ZIP archive into your preferred destination directory.
5665

5766
Start `SimpleAccounting.exe`.
@@ -60,12 +69,14 @@ Start `SimpleAccounting.exe`.
6069

6170
Contributions are welcome!
6271

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.
6576

6677
## TODOs
6778

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.
6980
Therefore, I am pretty sure that some of the words I used are confusing for native speakers.
7081
Perhaps you would like to help with better naming?
7182

@@ -81,7 +92,10 @@ The roadmap is defined by issues and milestones.
8192
I do not like closed source reuse of my software.
8293
This is why I decided to license the software under GPLV3.
8394

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).
8596
Additionally the package [CsvHelper](https://github.com/JoshClose/CsvHelper) is licensed from Josh Close under [MS-PL](https://opensource.org/licenses/MS-PL).
8697

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
99+
[Apache 2.0](https://licenses.nuget.org/Apache-2.0),
100+
[MS-PL](https://opensource.org/licenses/MS-PL),
101+
and [BSD-3-Clause](https://licenses.nuget.org/BSD-3-Clause).

tests/SimpleAccounting.IntegrationTests/SimpleAccounting.IntegrationTests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<ItemGroup>
99
<!-- license is apache 2.0 -->
1010
<PackageReference Include="FluentAssertions" Version="6.12.0" />
11-
<!-- license is MS.NET -->
11+
<!-- license is MIT -->
1212
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
1313
<!-- license is BSD-3-Clause -->
1414
<PackageReference Include="NSubstitute" Version="5.1.0"/>

tests/SimpleAccounting.UnitTests/SimpleAccounting.UnitTests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<ItemGroup>
1313
<!-- license is apache 2.0 -->
1414
<PackageReference Include="FluentAssertions" Version="6.12.0" />
15-
<!-- license is MS.NET -->
15+
<!-- license is MIT -->
1616
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
1717
<!-- license is BSD-3-Clause -->
1818
<PackageReference Include="NSubstitute" Version="5.1.0" />

0 commit comments

Comments
 (0)