buypeeb-cs/readme.md

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.

## quick start (arch linux)
```bash
git clone https://git.bune.city/lynnesbian/buypeeb-cs
cd buypeeb-cs
sudo pacman -S dotnet-sdk
dotnet run
```

## quick install (arch linux)
```bash
mkdir buypeeb
cd buypeeb
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/)

### debian
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
```

### 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)

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.

### 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.

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.
no capitalisation for this anticapitalist 2020-09-01 07:22:42 +00:00			`buypeeb`
i hope this actually goes somewhere and i don't abandon it a few days in 2020-08-28 16:04:37 +00:00			`===`

much better readme, build/release instructions, etc 2020-09-06 06:23:37 +00:00			`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.`
i hope this actually goes somewhere and i don't abandon it a few days in 2020-08-28 16:04:37 +00:00
added a quick start for the gamers amongst us 2020-09-01 07:25:39 +00:00			`## quick start (arch linux)`
			```bash
			`git clone https://git.bune.city/lynnesbian/buypeeb-cs`
			`cd buypeeb-cs`
			`sudo pacman -S dotnet-sdk`
			`dotnet run`
			```
better publish/build/etc workflow 2020-09-06 09:53:19 +00:00
now there's a desktop file 0uo 2020-09-06 10:59:46 +00:00			`## quick install (arch linux)`
better publish/build/etc workflow 2020-09-06 09:53:19 +00:00			```bash
you'll wanna do the pkgbuild in a subdir, lest you clutter your working dir with rubbish 2020-09-06 11:04:30 +00:00			`mkdir buypeeb`
			`cd buypeeb`
fixed curl command 2020-09-06 11:10:12 +00:00			`curl -O https://git.bune.city/lynnesbian/buypeeb-cs/raw/branch/master/PKGBUILD`
better publish/build/etc workflow 2020-09-06 09:53:19 +00:00			`makepkg -si # installs to /usr/bin/buypeeb`
welp 2020-09-06 10:04:17 +00:00			`buypeeb`
now there's a desktop file 0uo 2020-09-06 10:59:46 +00:00			```
added a quick start for the gamers amongst us 2020-09-01 07:25:39 +00:00			`---`

added a build.sh because i'm lazy 2020-09-01 07:16:42 +00:00			`## installing prerequisites`
much better readme, build/release instructions, etc 2020-09-06 06:23:37 +00:00			`you'll need the [dotnet core sdk](https://dotnet.microsoft.com/)`
i hope this actually goes somewhere and i don't abandon it a few days in 2020-08-28 16:04:37 +00:00
added a build.sh because i'm lazy 2020-09-01 07:16:42 +00:00			`### debian`
i think i prefer dotnet to mono 2020-09-01 07:18:31 +00:00			`follow [these instructions](https://docs.microsoft.com/en-us/dotnet/core/install/linux-debian) to add the dotnet repo and install dotnet-sdk.`

added a build.sh because i'm lazy 2020-09-01 07:16:42 +00:00			`### arch linux`
even more gooder readme 2020-09-01 07:12:58 +00:00			```
			`sudo pacman -S dotnet-sdk`
			```
arch install instructions 2020-08-31 13:58:27 +00:00
added a build.sh because i'm lazy 2020-09-01 07:16:42 +00:00			`### windows`
and there you have it 2020-09-01 05:18:15 +00:00			`- 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)
it took me several hours to figure out these install instructions and it turns out they're wrong anyway but i'm committing them here before replacing them with the actual instructions because of how long it took and ugh 2020-09-01 05:14:32 +00:00
i think i prefer dotnet to mono 2020-09-01 07:18:31 +00:00			`i have no idea how to install mono with gtksharp properly on windows, and believe me i tried`
it took me several hours to figure out these install instructions and it turns out they're wrong anyway but i'm committing them here before replacing them with the actual instructions because of how long it took and ugh 2020-09-01 05:14:32 +00:00
added a quick start for the gamers amongst us 2020-09-01 07:25:39 +00:00			`---`

i hope this actually goes somewhere and i don't abandon it a few days in 2020-08-28 16:04:37 +00:00			`## compiling`
it took me several hours to figure out these install instructions and it turns out they're wrong anyway but i'm committing them here before replacing them with the actual instructions because of how long it took and ugh 2020-09-01 05:14:32 +00:00			```
			`dotnet build`
			```
i hope this actually goes somewhere and i don't abandon it a few days in 2020-08-28 16:04:37 +00:00
added a quick start for the gamers amongst us 2020-09-01 07:25:39 +00:00			`---`
i think i prefer dotnet to mono 2020-09-01 07:18:31 +00:00			`## running`
improved readme B-) 2020-08-31 13:56:32 +00:00			```
it took me several hours to figure out these install instructions and it turns out they're wrong anyway but i'm committing them here before replacing them with the actual instructions because of how long it took and ugh 2020-09-01 05:14:32 +00:00			`dotnet run`
improved readme B-) 2020-08-31 13:56:32 +00:00			```
i think i prefer dotnet to mono 2020-09-01 07:18:31 +00:00
much better readme, build/release instructions, etc 2020-09-06 06:23:37 +00:00			`---`
			`## 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.

			`### 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.
i think i prefer dotnet to mono 2020-09-01 07:18:31 +00:00
much better readme, build/release instructions, etc 2020-09-06 06:23:37 +00:00			`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.`