Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aspriddell authored Jul 18, 2023
1 parent 1e5b2cd commit 85d3759
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ To minimise potential damage, the app will only list packages installed for the

### Releases
Releases can be downloaded from the "Releases" tab on the right-hand side of the GitHub repo.
The application is approx 50MB and contains:

- The app logic
- .NET Libraries
- UI Framework (Avalonia)
- Native Code for accelerating the startup time

## Usage
1. Download the latest version from the Releases tab
Expand All @@ -30,7 +36,7 @@ Releases can be downloaded from the "Releases" tab on the right-hand side of the
5. Close the app and send it to the recycle bin (or store it somewhere if you'd like to keep it for future use)

## Development
Kaplan is built as a .NET desktop app, using Avalonia UI and their ReactiveUI MVVM library. You will need to use a Windows desktop and run the IDE as an administrator to allow the app to boot properly
Kaplan is built as a .NET desktop app, using Avalonia UI and their ReactiveUI MVVM library. You will need to use a Windows desktop and run the IDE as an administrator to allow the app to boot properly.

**Debug builds do not uninstall packages**, but fakes the uninstallation process with a delay. Switching to release builds will remove this.

Expand Down

0 comments on commit 85d3759

Please sign in to comment.