https://github.com/cheat/snap
Snap recipe for cheat
https://github.com/cheat/snap
cheatsheet recipe snap
Last synced: 7 months ago
JSON representation
Snap recipe for cheat
- Host: GitHub
- URL: https://github.com/cheat/snap
- Owner: cheat
- License: other
- Created: 2019-01-30T06:42:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T06:05:09.000Z (almost 2 years ago)
- Last Synced: 2025-01-28T18:15:55.310Z (9 months ago)
- Topics: cheatsheet, recipe, snap
- Language: Shell
- Size: 123 KB
- Stars: 12
- Watchers: 4
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
cheat
This is the snap for cheat (based on https://github.com/cheat/cheat)
Published for 
with 💝 by Snapcrafters
## Install
$ snap install cheat
### Get testing version
$ snap install --channel=edge cheat
$ snap refresh --channel=edge cheat
## Cheatsheets
Community cheatsheets come from a [cheatsheet repository](https://github.com/cheat/cheatsheets) and are installed on first start.
These cheatsheets are read only, but can be updated calling: `$ cheat.update`.
They go into:
$HOME/snap/cheat/common/.config/cheat/cheatsheets/community
### Update
To update community cheatsheets call:
$ cheat.update
### Personal sheets
You can create your own cheatsheets via `cheat -e foo`
They go into:
$HOME/snap/cheat/common/.config/cheat/cheatsheets/personal
## Configuration
The config for cheat is stored here:
$HOME/snap/cheat/common/.config/cheat/conf.yml
## Buildstatus
[](https://snapcraft.io/cheat)
### Test latest build
$ snap refresh --edge cheat
## Install from store
[](https://snapcraft.io/cheat)
([Don't have snapd installed?](https://snapcraft.io/docs/core/install))
## How to use it
[See upstream README](https://github.com/cheat/cheat#example)
## Remaining tasks
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 cheat can authoritatively publish future releases.
- [x] Click the green "Use this template" button above to create a new repository based on this template
- [x] Give the newly created repository a sensible name, like `godzilla-snap` if you're snapping the Godzilla software
- [x] Fork the [Snapcrafters template](https://github.com/snapcrafters/fork-and-rename-me) repository to your own GitHub account.
- If you have already forked the Snapcrafter template to your account and want to create another snap, you'll need to use GitHub's [Import repository](https://github.com/new/import) feature because you can only fork a repository once.
- [x] Rename the forked Snapcrafters template repository
- [x] Update the description of the repository
- [x] Update logos and references to `cheat`
- [x] Create a snap that runs in `devmode`
- [x] Register the snap in the store, **using the preferred upstream name**
- [x] Add a screenshot to this `README.md`
- [x] Publish the `devmode` snap in the Snap store edge channel
- [x] Add install instructions to this `README.md`
- [x] Update snap store metadata, icons and screenshots
- [x] Convert the snap to `strict` confinement, or -`classic`- confinement if it qualifies
- [x] Publish the confined snap in the Snap store beta channel
- [x] Update the install instructions in this `README.md`
- [x] Post a call for testing on the [Snapcraft Forum](https://forum.snapcraft.io) - [Call for testing cheat](https://forum.snapcraft.io/t/call-for-testing-cheat)
- [-] 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
- [x] Add the provided Snapcraft build badge to this `README.md`
- [x] Publish the snap in the Snap store stable channel
- [x] Update the install instructions in this `README.md`
- [ ] Post an announcement in the [Snapcraft Forum](https://forum.snapcraft.io) - [link]()
- [x] Submit a pull request or patch upstream that adds snap install documentation - [link](https://github.com/cheat/snap#install)
- [x] Submit a pull request or patch upstream that adds the `snapcraft.yaml` and any required assets/launchers - [link](https://github.com/cheat/snap/blob/master/snap/snapcraft.yaml)
- [x] 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
| [Michael Berner](https://github.com/bernermic/) |
| [](https://github.com/cheat/snap) |
| [Chris Allen Lane](https://github.com/chrisallenlane/) |
| [](https://github.com/cheat/cheat) |
## Upstream
| [Cheat](https://github.com/cheat/cheat) |