summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRuben Pollan <meskio@sindominio.net>2018-08-21 20:12:57 +0200
committerRuben Pollan <meskio@sindominio.net>2018-08-21 20:18:42 +0200
commit69f39439c42ad177f77074cf0cbd9cb864820ae5 (patch)
treeeaac263336f73c235da339afc402335b2540bc72 /README.md
parent1d3d04fc6047767aba5d2e82e8ea12205720917c (diff)
[doc] add instructions on how to report an issue
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0b5b8d0..a6f8839 100644
--- a/README.md
+++ b/README.md
@@ -84,3 +84,16 @@ To rebuild the locales:
```
$ make locales
```
+
+
+Report an issue
+-------------------
+
+When you report an issue include the following information:
+* what you expected to see
+* what you got
+* the version of the program. You can check the version on the about page.
+* the logs of the program. The location of the logs depends on the OS:
+ * linux: `/home/<your user>/.config/leap/bitmaskd.log` & `/home/<your user>/.config/leap/systray.log`
+ * OSX: `/Users/<your user>/Library/Preferences/leap/systray.log`, `/Applications/RiseupVPN.app/Contents/helper/helper.log` & `/Applications/RiseupVPN.app/Contents/helper/openvpn.log`
+ * windows: `C:\Users\<your user>\AppData\Local\leap\systray.log`, `C:\Program Files\RiseupVPN\helper.log` & `C:\Program Files\RiseupVPN\openvp.log`