Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add getting started instructions to README

Browse source
This commit is contained in:
Ben Goldsworthy 2021-02-20 20:55:46 +00:00 committed by Rumperuu
parent 0b74ef0652
commit 166f79e698
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -66,6 +66,21 @@ Unit tests are TODO.
1. Install [phpDocumentor](https://phpdoc.org/) 1. Install [phpDocumentor](https://phpdoc.org/)
1. Run it (`phpDocumentor -d . -t docs`) 1. Run it (`phpDocumentor -d . -t docs`)
## Getting Started
1. Read the contributing guidelines
1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`)
1. Install [Composer](https://getcomposer.org/download/), if you don't have it already
1. Install dependencies (`composer install`)
1. Create a new branch from `main` (`git checkout -b <your-descriptive-branch-name>`)
1. When you're finished, commit your changes to the remote version of your branch
and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls).
## Updating Documentation
1. Install [phpDocumentor](https://phpdoc.org/)
1. Run it (`phpDocumentor -d . -t docs`)
## Main Features ## Main Features
- Fully customizable **footnotes** start and end shortcodes; - Fully customizable **footnotes** start and end shortcodes;