aboutsummaryrefslogtreecommitdiff
path: root/snap
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-06-30 15:13:47 -0700
committerMicah Lee <micah@micahflee.com>2020-06-30 15:13:47 -0700
commitf30cb02588a39b38e3d84eebb3b7b734810b7d54 (patch)
tree5e661923216a61a436fde5dbea56360cccc32017 /snap
parent6aec2418728099706839be24e7cf5a340154ac64 (diff)
downloadonionshare-f30cb02588a39b38e3d84eebb3b7b734810b7d54.tar.gz
onionshare-f30cb02588a39b38e3d84eebb3b7b734810b7d54.zip
Add snap readme
Diffstat (limited to 'snap')
-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
+```