Skip to content
This repository has been archived by the owner on Sep 2, 2019. It is now read-only.

Commit

Permalink
Add notes about GitHub specific part of the starter kit
Browse files Browse the repository at this point in the history
  • Loading branch information
@SeanTAllen
SeanTAllen committed Aug 4, 2019
1 parent cd099c5 commit 85a6438
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions USAGE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ This starter pack is opinionated. We suggest that you review:

Make sure that you agree with them. Feel free to make changes to suit your particular style.

## It assumes you are using GitHub for hosting

Both `release.bash` and `RELEASE_PROCESS.md` assume you are using GitHub. Accordingly, as part of the release process, they contains GitHub specific code and instructions related to adding and publishing release notes via GitHub's release feature. If you aren't using GitHub, you can still use the included release files but, you will have to modify them a little.

Additionally, the CONTRIBUTING.md assumes your project is hosted on GitHub and contains links to issues, forking, etc that are GitHub specific. If you aren't hosting on GitHub, you should update those links accordingly.

## What you need to update

This repository is templated. You'll want to replace anything in {} with the correct value. The following replacement values are required:
Expand Down

0 comments on commit 85a6438

Please sign in to comment.