From e2a0da1c728fa0fa653eb1d1f64287a229568fe1 Mon Sep 17 00:00:00 2001 From: Xjph Date: Sun, 6 Jun 2021 14:12:59 -0230 Subject: [PATCH] Added README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ed8047 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Elite Observatory **Core** +Tool for reading/monitoring Elite Dangerous journals for interesting objects. Successor to the original Elite Observatory, rewritten from scratch using .NET 5.0 and AvaloniaUI. + +## How To Use +Observatory Core differs from the originsl Elite Observatory in that it is a fully generic reader for the Elite Dangerous journal files, passing those events along to plugins to do the actual work. + +For specifics on what each plugin does, please refer to their specific github repositories: +* [Explorer](https://github.com/Xjph/ObservatoryExplorer) +* [Botanist](https://github.com/Xjph/ObservatoryBotanist) + +## Prerequisites for use +.NET 5, and by extension one of its [supported OSes](https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0-supported-os.md). + +## Prerequisites for building +C# 9.0, .NET 5.0, [AvaloniaUI 0.10.3](https://github.com/AvaloniaUI/Avalonia).