added an overview to readme

This commit is contained in:
Wyatt J. Miller 2022-06-30 22:07:20 -04:00
parent d4055211df
commit b16a0867eb

View File

@ -6,6 +6,7 @@ Licensed by the Mozilla Public License version 2
## Table of Contents ## Table of Contents
- [Overview](#overview)
- [Building](#building) - [Building](#building)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Getting the source code](#getting-the-source-code) - [Getting the source code](#getting-the-source-code)
@ -13,6 +14,20 @@ Licensed by the Mozilla Public License version 2
- [Documentation](#documentation) - [Documentation](#documentation)
- [Contribution](#contribution) - [Contribution](#contribution)
## Overview
A cross platform application that shows repository and user data from GitHub, built with Avalonia.
So, I finally done it.
I have built a [project](https://scm.wyattjmiller.com/wymiller/DeskHubSharp) in the past that achieves the same goals as this application (albeit unmaintained), but this project is much, much different. I took the original program, ripped out the WPF bits, and stored all the Avalonia bits where the WPF bits used to be, with a few additions. While this project is going to serve a great portion of what the original project did, there are a few adjustments, and perhaps a few additions.
I also ripped out the legacy .NET Framework and put .NET 6 in it's place, which brings many [improvements](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6).
###### What is Avalonia?
Think WPF but cross platform. Avalonia still runs your favorite declarative language, XAML, but applies a different drawing library, Skia (SkiaSharp). What Skia allows Avalonia to do is draw windows, buttons, and other widgets on not just Windows, but macOS, Linux, Android, and iOS. Even Web Assembly! Learn more [here](http://avaloniaui.net/).
## Building ## Building
### Requirements ### Requirements
@ -45,7 +60,7 @@ If you want to build for production for Windows, run:
## Documentation ## Documentation
To see the documentation, please run the following command in Powershell/bash: To see the developer documentation, please run the following command in Powershell/bash:
`doxygen` `doxygen`
@ -53,6 +68,8 @@ Please note that you have to be in the root of the cloned directory to generate
`doxygen /path/to/Doxyfile` `doxygen /path/to/Doxyfile`
Also note that this step is optional. This step only generates documentation, which isn't used in running the program.
## Contribution ## Contribution
Issues and pull requests are more than welcome. Issues and pull requests are more than welcome.