From 1af03bf2be8ce7faa1a6447c006127d87c956663 Mon Sep 17 00:00:00 2001
From: Lynne <lynne@bune.city>
Date: Tue, 15 Jun 2021 12:08:51 +1000
Subject: [PATCH] minor readme updates

---
 readme.md | 45 +++++++++++++++++++++++++++++++++++++--------
 1 file changed, 37 insertions(+), 8 deletions(-)

diff --git a/readme.md b/readme.md
index ab4c4a4..3aa09a2 100644
--- a/readme.md
+++ b/readme.md
@@ -1,9 +1,11 @@
 buypeeb
 ===
 
-a simple dotnet core program that allows you to track auctions on yahoo auctions japan, written in c#. designed for and with linux, but works on windows.
+a simple dotnet core program that allows you to track auctions on yahoo auctions japan, written in c#. designed for and
+with linux, but works on windows.
 
 ## quick start (arch linux)
+
 ```bash
 git clone https://git.bune.city/lynnesbian/buypeeb-cs
 cd buypeeb-cs
@@ -12,6 +14,7 @@ dotnet run
 ```
 
 ## quick install (arch linux)
+
 ```bash
 mkdir buypeeb
 cd buypeeb
@@ -19,49 +22,75 @@ curl -O https://git.bune.city/lynnesbian/buypeeb-cs/raw/branch/master/PKGBUILD
 makepkg -si # installs to /usr/bin/buypeeb
 buypeeb
 ```
+
 ---
 
 ## installing prerequisites
-you'll need the [dotnet core sdk](https://dotnet.microsoft.com/)
+
+you'll need the [dotnet core sdk](https://dotnet.microsoft.com/). buypeeb is written for .NET 5.0, so you'll need to
+make sure you install that SDK version.
 
 ### debian
-follow [these instructions](https://docs.microsoft.com/en-us/dotnet/core/install/linux-debian) to add the dotnet repo and install dotnet-sdk.
+
+follow [these instructions](https://docs.microsoft.com/en-us/dotnet/core/install/linux-debian) to add the dotnet repo
+and install dotnet-sdk.
 
 ### arch linux
+
 ```
 sudo pacman -S dotnet-sdk
 ```
 
+### other linux distros
+
+follow [these instructions](https://docs.microsoft.com/en-us/dotnet/core/install/linux) to install the relevant dotnet
+SDK.
+
 ### windows
-- download and install ".NET Core SDK" from [this page](https://dotnet.microsoft.com/download)
-- run `dotnet build` - this *should* pull in gtk3 automatically - if not, you'll need to [install it yourself](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases/latest)
+
+- download and install ".NET 5.0" from [this page](https://dotnet.microsoft.com/download/dotnet)
+- run `dotnet build` - this *should* pull in gtk3 automatically - if not, you'll need
+  to [install it yourself](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases/latest)
 
 i have no idea how to install mono with gtksharp properly on windows, and believe me i tried
 
 ---
 
 ## compiling
+
 ```
 dotnet build
 ```
 
 ---
+
 ## running
+
 ```
 dotnet run
 ```
 
 ---
+
 ## compiling a standalone version
+
 the standalone versions are rather big, so it's a good idea to compress them for distribution.
+
 ### linux
+
 run `./release.sh`.
 
-the binary will be located at `./out/release/linux/buypeeb`, with a [zstandard](https://facebook.github.io/zstd/) compressed version at `buypeeb.tar.zst` in the same directory.
+the binary will be located at `./out/release/linux/buypeeb`, with a [zstandard](https://facebook.github.io/zstd/)
+compressed version at `buypeeb.tar.zst` in the same directory.
 
 ### windows
+
 run `.\release.ps1`.
 
-the binary will be located at `.\out\release\windows\buybeep.exe`, with a zip compressed version at `buypeep.zip` in the same directory.
+the binary will be located at `.\out\release\windows\buybeep.exe`, with a zip compressed version at `buypeep.zip` in the
+same directory.
 
-unfortunately, however, this program won't work on machines that don't have GTK3 installed, and installing GTK3 is [quite an undertaking](https://www.gtk.org/docs/installations/windows/). a solution for this is [in the works](https://github.com/GtkSharp/GtkSharp/issues/119), but there's not really anything to be done about it right now.
+unfortunately, however, this program won't work on machines that don't have GTK3 installed, and installing GTK3
+is [quite an undertaking](https://www.gtk.org/docs/installations/windows/). a solution for this
+is [in the works](https://github.com/GtkSharp/GtkSharp/issues/119), but there's not really anything to be done about it
+right now.