From 99373b47c088550f31d91707208997720f45010e Mon Sep 17 00:00:00 2001
From: Florian Stinglmayr <fstinglmayr@gmail.com>
Date: Sat, 10 Dec 2022 11:53:41 +0100
Subject: [PATCH] add repo README

---
 EDBGS.sln |  5 +++++
 README.md | 11 +++++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/EDBGS.sln b/EDBGS.sln
index 3d019c7..600502b 100644
--- a/EDBGS.sln
+++ b/EDBGS.sln
@@ -9,6 +9,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EDPlayerJournalTests", "EDP
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EliteBGS", "EliteBGS\EliteBGS.csproj", "{14B03115-B9D5-4006-A993-9A5069BB172E}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1381D5DE-139E-4FEC-BDC4-A3FDADEAEE5C}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ea7b987
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# EDBGS
+
+EDBGS is a project containing the EliteBGS BGS application. It also contains the dotnet
+class library EDPlayerJournal, which reads and parses Elite Dangerous player journals.
+
+See [https://bgs.n0la.org/](https://bgs.n0la.org) for further details.
+
+## Requirements
+
+This repository depends on dotnet desktop SDK 7, as well as Newtonsoft.JSON and Ookii
+Dialogs.