vim-ale/.github/ISSUE_TEMPLATE/new_installer.md

name, about, title, labels

name	about	title	labels
New Installer	Create a new installer for webinstall.dev	[Installer] Add CHANGE-ME	good first issue first-timers-only up-for-grabs

Add CHANGE-ME

We want to add CHANGE-ME because...

• it works consistently across Windows, Mac, and Linux.

This could be as simple as copying _example, updating the github releases info, and doing a find and replace on a few file system path names.

How to create a webi installer

Skills required

• Basic Command Line knowledge (mkdir, mv, ls, tar, unzip, variables)

Steps

1. Clone and setup the webi packages repo

   git clone git@github.com:webinstall/packages.git
   pushd packages/
   npm install
   

2. Copy the example template and update with info from Official Releases: https://github.com/___CHANGE/ME___/releases

   rsync -av _example/ CHANGE-ME/
   

   • update CHANGE-ME/release.js to use the official repo
   • Learn how CHANGE-ME unpacks (i.e. as a single file? as a .tar.gz? as a .tar.gz with a folder named CHANGE-ME?)
   • find and replace to change the name
     • update CHANGE-ME/install.sh (see bat and jq as examples)
     • update CHANGE-ME/install.ps1 (see bat and jq as examples)
3. Needs an updated tagline and cheat sheet
   • update CHANGE-ME/README.md
     • official URL
     • tagline
     • Switch versions
     • description / summary
     • General pointers on usage (and perhaps "gotchas")

It's also okay to have multiple people work on part of this (i.e. the Cheat Sheet can be done independently from the install.sh)