diff --git a/README.md b/README.md new file mode 100644 index 0000000..972e79e --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +Borepin +=== + +# Building + +## On Windows +1. Install Visual Studio 2019 + [download Visual Studio](https://visualstudio.microsoft.com/de/) + * with Xamarin + * with UWP + * with .NET Desktop +2. Install GTKSharp for Windows + [download GTKSharp](https://www.mono-project.com/download/stable/#download-win) +4. Clone Borepin + [download Borepin](https://gitlab.com/fabinfra/fabaccess/client) +6. Load Borepin +7. Build Borepin + +If Step 5. Build Borepin is failing because of GTKSharp, it could help to restart your PC. + +## Build GTK Project +1. Install mono, gtk-sharp, msbuild, nuget + 1.1 Debian based + ```shell + $ apt install mono-complete, gtk-sharp2, nuget + ``` + 1.2 ArchLinux based + ```shell + $ pacman -S mono, mono-msbuild, gtk-sharp-2, nuget + ``` +2. Clone Borepin + ```shell + $ git clone https://gitlab.com/fabinfra/fabaccess/client.git + ``` + +3. Build Borepin + ```shell + $ cd client + $ msbuild -t:Borepin_GTK + ``` +4. Run Borepin + ```shell + $ mono ./Borepin/Borepin.GTK/bin/Debug/Borepin.GTK.exe + ``` +You can also use Rider or monodevelop as an IDE for development on Borepin + +## Testing +We use [NUnit](https://nunit.org/) for testing.