Skip to content

Add installer for PUT_WHAT_YOU_WANT_HERE #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
flaan4me wants to merge 1 commit into from
Closed

Add installer for PUT_WHAT_YOU_WANT_HERE #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,41 @@ info, and doing a find and replace on a few file system path names.
- [ ] Switch versions
- [ ] description / summary
- [ ] General pointers on usage (and perhaps "gotchas")

# How to create a webi installer for PUT_WHAT_YOU_WANT_HERE

[![Video Tutorial: How to create a webi Installer](https://user-images.githubusercontent.com/122831/91064908-17f28100-e5ed-11ea-9cf0-ab3363cdf4f8.jpeg)](https://youtu.be/RDLyJtiyQHA)

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.

## Skills required

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

## Steps

1. Clone and setup the webi packages repo
```sh
git clone git@github.com:webinstall/packages.git
cd ./packages/
npm install
```
2. Copy the example template and update with info from Official Releases:
<https://github.com/PUT_WHAT_YOU_WANT_HERE/releases>
```sh
rsync -av _example/ PUT_WHAT_YOU_WANT_HERE/
```
- [ ] update `PUT_WHAT_YOU_WANT_HERE/release.js` to use the official repo
- [ ] Learn how `PUT_WHAT_YOU_WANT_HERE` unpacks (i.e. as a single file? as a .tar.gz? as
a .tar.gz with a folder named PUT_WHAT_YOU_WANT_HERE?)
- [ ] find and replace to change the name
- [ ] update `PUT_WHAT_YOU_WANT_HERE/install.sh` (see `bat` and `jq` as examples)
- [ ] update `PUT_WHAT_YOU_WANT_HERE/install.ps1` (see `bat` and `jq` as examples)
3. Needs an updated tagline and cheat sheet
- [ ] update `PUT_WHAT_YOU_WANT_HERE/README.md`
- [ ] official URL
- [ ] tagline
- [ ] Switch versions
- [ ] description / summary
- [ ] General pointers on usage (and perhaps "gotchas")
6 changes: 3 additions & 3 deletions docs/ISSUE_TEMPLATE/new_installer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: New Installer
about: Create a new installer for webinstall.dev
title: '[Installer] Add CHANGE-ME'
title: '[Installer] Add PUT_WHAT_YOU_WANT_HERE'
labels:
- 'good first issue'
- first-timers-only
Expand All @@ -10,11 +10,11 @@ labels:

<!-- Please fill out the information below -->

# Add CHANGE-ME
# Add PUT_WHAT_YOU_WANT_HERE

<!-- what do you want to see added to webinstall.dev? why? -->

We want to add `CHANGE-ME` because...
We want to add `PUT_WHAT_YOU_WANT_HERE` because...

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

Expand Down