Skip to content

cheat/snap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cheat

This is the snap for cheat (based on https://github.com/cheat/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 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

cheat

Test latest build

$ snap refresh --edge cheat

Install from store

Get it from the Snap Store

(Don't have snapd installed?)

How to use it

See upstream README

Remaining tasks

Snapcrafters (join us) are working to land snap install documentation and the snapcraft.yaml upstream so cheat can authoritatively publish future releases.

  • 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
  • Fork the Snapcrafters template 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 feature because you can only fork a repository once.
  • Rename the forked Snapcrafters template repository
  • Update the description of the repository
  • Update logos and references to cheat
  • 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 - Call for testing cheat
  • [-] Make a post in the Snapcraft Forum asking for a transfer of the snap name from you to snapcrafters - link
  • [-] Ask a Snapcrafters admin 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 - 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.

The Snapcrafters

| Michael Berner | | cheat-snap | | Chris Allen Lane | | cheat |

Upstream

| Cheat |