Awesome
GitHub Setup
This is a tiny script easing the setup of Pharo projects in GitHub.
It will create a base project structure for a Pharo project following the ba-st conventions.
License
The code is licensed under MIT.
Quick Start
Pre-Requisites
- Create your project in GitHub.
- Configure Coverage
- If you want to use the automatic e-mail notification on releases follow the instructions here.
Usage
- Clone this repository
- Run
setup.sh
providing the required information - Choose the name of your default branch. We use
release-candidate
, if you want a different one adapt the next steps as needed and use-d
option - Review the proposed files and adapt it to your own needs
- Clone your new repository
- Create a new branch called
release-candidate
:git checkout -b release-candidate
- Move the proposed file structure into your repo (keep an eye on the hidden files)
- Commit and push the changes to GitHub
- Go to the repo settings, set as default branch and protect the
release-candidate
branch
Proposed Project Structure
The script will propose the following structure:
assets/
: Static resourcesdocs/
: Documentationdocs/README.md
: Documentation READMEdocs/explanation
: Explanations and discussionsdocs/how-to
: How-to guidesdocs/reference
: Reference guidesdocs/tutorial
: Tutorialssource/
: Source CodeREADME.md
: READMECONTRIBUTING.md
: Contribution GuidelinesLICENSE
: MIT License
Contributing
Check the Contribution Guidelines