forked from capruro/dante-snap
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit a6b7ffa
Showing
5 changed files
with
151 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 4 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = false | ||
insert_final_newline = false | ||
|
||
[*.yaml] | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
#snapcraft specifics | ||
/parts/ | ||
/stage/ | ||
/prime/ | ||
|
||
*.snap | ||
|
||
.snapcraft | ||
__pycache__ | ||
*.pyc | ||
*_source.tar.bz2 | ||
snap/.snapcraft |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2017 Snapcrafters | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
<h1 align="center"> | ||
<img src="https://avatars1.githubusercontent.com/u/29598503?v=3&s=256" alt="[Project]"> | ||
<br /> | ||
[Project] | ||
</h1> | ||
|
||
<p align="center"><b>This is the snap for [Project]</b>, <i>“Single-line elevator pitch for your amazing snap”</i>. It works on Ubuntu, Fedora, Debian, and other major Linux | ||
distributions.</p> | ||
|
||
<!-- Uncomment and modify this when you are provided a build status badge | ||
<p align="center"> | ||
<a href="https://build.snapcraft.io/user/snapcrafters/fork-and-rename-me"><img src="https://build.snapcraft.io/badge/snapcrafters/fork-and-rename-me.svg" alt="Snap Status"></a> | ||
</p> | ||
--> | ||
|
||
<!-- Uncomment and modify this when you have a screenshot | ||
![my-snap-name](screenshot.png?raw=true "my-snap-name") | ||
--> | ||
|
||
<p align="center">Published for <img src="https://raw.githubusercontent.com/anythingcodes/slack-emoji-for-techies/gh-pages/emoji/tux.png" align="top" width="24" /> with 💝 by Snapcrafters</p> | ||
|
||
## Install | ||
|
||
sudo snap install my-snap-name | ||
|
||
<!-- Uncomment and modify this when your snap is available on the store | ||
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/my-snap-name) | ||
--> | ||
|
||
([Don't have snapd installed?](https://snapcraft.io/docs/core/install)) | ||
|
||
## Remaining tasks | ||
<!-- Uncomment and modify this when you have a screenshot | ||
![my-snap-name](screenshot.png?raw=true "my-snap-name") | ||
--> | ||
|
||
Snapcrafters ([join us](https://forum.snapcraft.io/t/join-snapcrafters/1325)) | ||
are working to land snap install documentation and | ||
the [snapcraft.yaml](https://github.com/snapcrafters/fork-and-rename-me/blob/master/snap/snapcraft.yaml) | ||
upstream so [Project] can authoritatively publish future releases. | ||
|
||
- [x] Click the green "Use this template" button above to create a new repository based on this template | ||
- [ ] Give the newly created repository a sensible name, like `godzilla-snap` if you're snapping the Godzilla software | ||
- [ ] Update the description of the repository | ||
- [ ] Update logos and references to `[Project]` and `[my-snap-name]` | ||
- [ ] Create a snap that runs in `devmode` | ||
- [ ] Register the snap in the store, **using the preferred upstream name** | ||
- [ ] Add a screenshot to this `README.md` | ||
- [ ] Publish the `devmode` snap in the Snap store edge channel | ||
- [ ] Add install instructions to this `README.md` | ||
- [ ] Update snap store metadata, icons and screenshots | ||
- [ ] Convert the snap to `strict` confinement, or `classic` confinement if it qualifies | ||
- [ ] Publish the confined snap in the Snap store beta channel | ||
- [ ] Update the install instructions in this `README.md` | ||
- [ ] Post a call for testing on the [Snapcraft Forum](https://forum.snapcraft.io) - [link]() | ||
- [ ] Make a post in the [Snapcraft Forum](https://forum.snapcraft.io) asking for a transfer of the snap name from you to snapcrafters - [link]() | ||
- [ ] Ask a [Snapcrafters admin](https://github.com/orgs/snapcrafters/people?query=%20role%3Aowner) to fork your repo into github.com/snapcrafters, and configure the repo for automatic publishing into edge on commit | ||
- [ ] Add the provided Snapcraft build badge to this `README.md` | ||
- [ ] Publish the snap in the Snap store stable channel | ||
- [ ] Update the install instructions in this `README.md` | ||
- [ ] Post an announcement in the [Snapcraft Forum](https://forum.snapcraft.io) - [link]() | ||
- [ ] Submit a pull request or patch upstream that adds snap install documentation - [link]() | ||
- [ ] Submit a pull request or patch upstream that adds the `snapcraft.yaml` and any required assets/launchers - [link]() | ||
- [ ] Add upstream contact information to the `README.md` | ||
- If upstream accept the PR: | ||
- [ ] Request upstream create a Snap store account | ||
- [ ] Contact the Snap Advocacy team to request the snap be transferred to upstream | ||
- [ ] Ask the Snap Advocacy team to celebrate the snap - [link]() | ||
|
||
If you have any questions, [post in the Snapcraft forum](https://forum.snapcraft.io). | ||
|
||
<!-- | ||
## The Snapcrafters | ||
| [![Your Name](https://gravatar.com/avatar/bc0bced65e963eb5c3a16cab8b004431/?s=128)](https://github.com/yourname/) | | ||
| :---: | | ||
| [Your Name](https://github.com/yourname/) | | ||
--> | ||
|
||
<!-- Uncomment and modify this when you have upstream contacts | ||
## Upstream | ||
| [![Upstream Name](https://gravatar.com/avatar/bc0bced65e963eb5c3a16cab8b004431?s=128)](https://github.com/upstreamname) | | ||
| :---: | | ||
| [Upstream Name](https://github.com/upstreamname) | | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: my-snap-name # you probably want to 'snapcraft register <name>' | ||
version: '0.1' # just for humans, typically '1.2+git' or '1.3.2' | ||
summary: Single-line elevator pitch for your amazing snap # 79 char long summary | ||
description: | | ||
This is my-snap's description. You have a paragraph or two to tell the | ||
most important story about your snap. Keep it under 100 words though, | ||
we live in tweetspace and your description wants to look good in the snap | ||
store. | ||
confinement: devmode # use 'strict' once you have the right plugs and slots | ||
|
||
parts: | ||
my-part: | ||
# See 'snapcraft plugins' | ||
plugin: nil |