Add Readme

2020-03-14 20:32:41 -07:00 · 2020-03-14 20:32:41 -07:00 · 3f8d91da3c
parent ff2916162c
commit 3f8d91da3c
3 changed files with 22 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,21 @@
+# Ephemeral Garden
+
+![](./garden.png)
+
+## To Build
+
+You will need to have installed Qt development libs (e.g. 5.13.1) and  [therecipe/qt](https://github.com/therecipe/qt). 
+
+    go mod vendor
+    qtdeploy  --qt_version "5.13.1" build linux
+    
+## To Host a Garden
+       ./deploy/linux/garden
+       Ephemeral Garden: hctctpqdjn7n6bgugg7u4hq2adbbeapbg3qt7m2jy42pfizbhcmty5ad
+       
+Wait for the other user to connect.       
+
+## To Connect to a Garden
+        ./deploy/linux/garden hctctpqdjn7n6bgugg7u4hq2adbbeapbg3qt7m2jy42pfizbhcmty5ad
+        
+Currently only 1 person can connect to garden at a time.
--- a/garden.png
+++ b/garden.png
--- a/go.mod
+++ b/go.mod
@ -5,5 +5,6 @@ go 1.13
 require (
 	cwtch.im/tapir v0.1.16
 	git.openprivacy.ca/openprivacy/connectivity v1.1.1
+	git.openprivacy.ca/openprivacy/log v1.0.0
 	github.com/therecipe/qt v0.0.0-20191101232336-18864661ae4f
 )