From 5ce214cf10fe2ed15ccee40394b0f539415780b5 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 20:55:46 +0000 Subject: [PATCH] Add getting started instructions to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6a3e29e..d57f0f6 100644 --- a/README.md +++ b/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 `) +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;