add Readme with build and test instructions

2019-10-21 22:47:32 +02:00 · 2019-10-21 22:47:32 +02:00 · 2fbfda643b
parent 488393fb22
commit 2fbfda643b
1 changed files with 10 additions and 0 deletions
--- a/Readme.md
+++ b/Readme.md
@ -0,0 +1,10 @@
+## NixOS overlay for [Seafile](https://seafile.com)
+
+This is an ongoing attempt to package the Seafile server and create a NixOS module for it.
+
+### testing
+
+- building package:
+  1. add this overlay to your [nixpkgs overlay configuration](https://nixos.wiki/wiki/Overlays)
+  1. `nix-build '<nixpkgs>' -A seafile-server`
+- testing the NixOS module in a VM: `NIXOS_CONFIG="$(pwd)/seafile-test.nix" nixos-rebuild build-vm --fast --show-trace && result/bin/run-nixos-vm`