Add additional content

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-  <img src="https://avatars1.githubusercontent.com/u/29598503?v=3&s=256" alt="Project">
+  <img src="snap/gui/icon.png" alt="Project" style="height: 256px">
   <br />
   [Project]
 </h1>
@@ -15,12 +15,12 @@ distributions.</p>
 
 ## Install
 
-    sudo snap install my-snap-name
+    sudo snap install --channel=edge --devmode my-snap-name
 
 ([Don't have snapd installed?](https://snapcraft.io/docs/core/install))
 
 <!-- Uncomment and modify this when you have a screenshot
-![my-snap-name](screenshot.png?raw=true "my-snap-name")
+![my-snap-name](snap/screenshots/screenshot.png?raw=true "my-snap-name")
 -->
 
 <p align="center">Published for <img src="http://anything.codes/slack-emoji-for-techies/emoji/tux.png" align="top" width="24" /> with :gift_heart: by Snapcrafters</p>

snap/README.markdown

@@ -0,0 +1,5 @@
+# /snap
+
+[Snaps are universal Linux packages](https://snapcraft.io/).  Snaps are containerised software packages that are simple to create and install on all major Linux systems without modification.
+
+Here are the files used for snap packaging, refer [snaps and snapcraft documentation](https://docs.snapcraft.io/) for more info.

snap/gui/README.markdown

@@ -0,0 +1,5 @@
+ # /snap/gui
+
+Copy the snapped application's icon here and specify it in snapcraft.yaml file using the `icon` keyword.  This folder is not necessary if the icon is already existed in the source tree.
+
+NOTE: The Snap Store requires SVG scalable image or PNG image with at least 256x256px in size.

snap/patches/README.markdown

@@ -0,0 +1,3 @@
+# /snap/patches
+
+Here are the patches that are required to build a snap package that functions correctly.

snap/patches/patch-desktop-entries.sed

@@ -0,0 +1,28 @@
+# This sed script patches the desktop entries of the snapped
+# application.
+#
+# Documentation:
+#
+# * GNU Sed Manual
+#   https://www.gnu.org/software/sed/manual
+#     * `sed` script overview - `sed` scripts
+#     * `sed` commands summary - `sed` scripts
+#     * The `s` Command - `sed` scripts
+#     * Overview of basic regular expression syntax - Regular
+#       Expressions: selecting text
+#     * Back-references and Subexpressions - Regular Expressions:
+#       selecting text
+
+## Append '(Snappy Edition)' to the application name to make it
+## distinguishable with the other same application using different
+## software distribution technologies
+##
+## FIXME: The appended string is not localizable, the proper way to
+##        implement this is to probably use a new X-Snappy-Name keys
+##        with localestring format to let the translators fill in
+##        additional localized string and use these values to replace
+##        the Name keys here.
+s/^\(Name\(\[.\+\]\)\?=.*\)$/\1 (Snappy Edition)/g
+
+## Fix-up application icon lookup
+s|^Icon=.*|Icon=\${SNAP}/meta/gui/icon.svg|

snap/screenshots/README.markdown

@@ -0,0 +1,3 @@
+# Screenshots
+
+The screenshots of the snapped application.  This is not currently synced to the product page on the Snap Store and should be uploaded by yourself.

snap/snapcraft.yaml

@@ -8,8 +8,63 @@ description: |
   store.
 
 confinement: devmode # use 'strict' once you have the right plugs and slots
+grade: devel
+icon: snap/gui/icon.png
+
+apps:
+  my-app:
+    command: my-app
+    desktop: share/applications/my-app.desktop
+    #plugs:
+    #- desktop
+    #- desktop-legacy
+    #- x11
+    #- unity7
+
+    #slots:
 
 parts:
-  my-part:
+  # Patches to fix other parts
+  patches:
+    source: snap/patches
+    source-type: local
+    plugin: dump
+
+    # DISABLED: Bug #1775582 “`organize:{ /: another-dir/ }` causes the items under host root directory to be copied in another-dir” : Bugs : Snapcraft
+    # https://forum.snapcraft.io/t/organize-another-dir-causes-the-items-under-host-root-directory-to-be-copied-in-another-dir/5806
+    #organize:
+        #/: patches/
+    override-build: |
+      set -eu
+
+      snapcraftctl build
+
+      mkdir \
+        --parents \
+        "$SNAPCRAFT_PART_INSTALL"/patches
+      mv \
+        "$SNAPCRAFT_PART_INSTALL"/*.diff \
+        "$SNAPCRAFT_PART_INSTALL"/*.patch \
+        "$SNAPCRAFT_PART_INSTALL"/*.sed \
+        "$SNAPCRAFT_PART_INSTALL"/patches \
+        || true # Empty patches folder is allowed
+    stage:
+    - patches/*
+    override-prime: 'true'
+
+  my-app:
+    after:
+    - patches
+
     # See 'snapcraft plugins'
     plugin: nil
+
+    override-stage: |
+      set -eu
+
+      snapcraftctl stage
+
+      sed \
+        --file "${SNAPCRAFT_STAGE}"/patches/patch-desktop-entries.sed \
+        --in-place \
+        "${SNAPCRAFT_STAGE}"/share/applications/*.desktop