README.md

tui-shop-repo

 _____ _   _ ___     ____  _   _  ___  ____  
|_   _| | | |_ _|   / ___|| | | |/ _ \|  _ \ 
  | | | | | || |____\___ \| |_| | | | | |_) |
  | | | |_| || |_____|__) |  _  | |_| |  __/ 
  |_|  \___/|___|   |____/|_| |_|\___/|_|    

The place that all apps from tui-shop live in.

Uploading an app

Quickstart

1. Create a json file with the template from template.json, (See 'Making a json file')

2. Create a logo, (See 'Creating a logo')

3. Fork this repo,

4. Name and upload your file to your forked repository's apps directory,

5. Open a pull request,

6. Wait. (In meantime, check 'Other')

Making a json file

Download the template.json file and fill all of the fields:

repo: your github repo,

description: description of your app,

logo: your app's logo, (See 'Creating a logo')

dependencies: a list of your dependencies,

actions: install: a list of shell commands to install your app, (the git clone and cd commands will be done automatically) remove: a list of shell commands to remove your app. (the git clone and cd commands will be done automatically)

Creating a logo

Your logo needs to be 6x6 pixels.

To choose a color of the pixel, put a letter corresponding to the first letter of the color:

• b = blue/dark blue

• r = red/dark red

• l = lime/light green

• y = yellow/light yellow

• p = purple/magenta

• w = white/light gray

• d = dark/black

• g = gray/dark gray

• n = none/transparent

Other

Badges

Here's some badges you can include in your repo's README:

Get on tui-shop

The logo

Main repo

Gcat101/Tui-shop