aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--snap/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/snap/README.md b/snap/README.md
new file mode 100644
index 00000000..54f80476
--- /dev/null
+++ b/snap/README.md
@@ -0,0 +1,28 @@
+# Snap package
+
+This folder contains files to build a [snap package](https://snapcraft.io/). First make sure you install `snap` and `snapcraft` (`snap install snapcraft --classic`).
+
+To build the snap, cd to the `snap` folder and run:
+
+```sh
+snapcraft
+```
+
+See your installed snaps:
+
+```sh
+snap list
+```
+
+Run the OnionShare snap:
+
+```sh
+/snap/bin/onionshare # CLI version
+/snap/bin/onionshare-gui # GUI version
+```
+
+Delete the OnionShare snap:
+
+```sh
+snap remove onionshare
+```