Add getting started instructions to README
This commit is contained in:
parent
8207c90e5e
commit
22282f9df1
1 changed files with 15 additions and 0 deletions
15
README.md
15
README.md
|
@ -8,6 +8,21 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor
|
|||
|
||||
**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing.
|
||||
|
||||
## 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
|
||||
|
||||
- Fully customizable **footnotes** start and end shortcodes;
|
||||
|
|
Reference in a new issue