moodle-local_mycerts/README.md

# The custom certificate activity

This activity allows the dynamic generation of PDF certificates with complete customisation via the web browser.

## Installation

There are two installation methods that are available. 

Follow one of these, then log into your Moodle site as an administrator and visit the notifications page to complete the install.

### Git

This requires Git being installed. If you do not have Git installed, please visit the [Git website](https://git-scm.com/downloads "Git website").

Once you have Git installed, simply visit your Moodle mod directory and clone the repository using the following command.

```
git clone https://github.com/markn86/moodle-mod_customcert.git customcert
```

Then checkout the branch corresponding to the version of Moodle you are using with the following command. Make sure to replace MOODLE_32_STABLE with the version of Moodle you are using.

```
git checkout MOODLE_32_STABLE
```

Use `git pull` to update this repository periodically to ensure you have the most recent updates.

### Download the zip

Visit the [Moodle plugins website](https://moodle.org/plugins/mod_customcert "Moodle plugins website") and download the zip corresponding to the version of Moodle you are using. Extract the zip and place the 'customcert' folder in the mod folder in your Moodle directory.

## More information

Visit the [wiki page](https://docs.moodle.org/en/Custom_certificate_module "Wiki page") for more details. Also, it is a wiki, so please feel free to edit it. :)

## License

Licensed under the [GNU GPL License](http://www.gnu.org/copyleft/gpl.html).
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`# The custom certificate activity`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`This activity allows the dynamic generation of PDF certificates with complete customisation via the web browser.`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`## Installation`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`There are two installation methods that are available.`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`Follow one of these, then log into your Moodle site as an administrator and visit the notifications page to complete the install.`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`### Git`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`This requires Git being installed. If you do not have Git installed, please visit the [Git website](https://git-scm.com/downloads "Git website").`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`Once you have Git installed, simply visit your Moodle mod directory and clone the repository using the following command.`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Minor tweaks to README.md 2017-04-28 02:42:55 +00:00			```
			`git clone https://github.com/markn86/moodle-mod_customcert.git customcert`
			```
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Minor tweaks to README.md 2017-04-28 02:42:55 +00:00			`Then checkout the branch corresponding to the version of Moodle you are using with the following command. Make sure to replace MOODLE_32_STABLE with the version of Moodle you are using.`
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Minor tweaks to README.md 2017-04-28 02:42:55 +00:00			```
			`git checkout MOODLE_32_STABLE`
			```
Module will install successfully with limited functionality The module will add tables to the DB on install, you can then add/edit instances and add/edit pages to these instances. 2012-12-07 09:34:46 +00:00
#106 Minor tweaks to README.md 2017-04-28 02:42:55 +00:00			Use `git pull` to update this repository periodically to ensure you have the most recent updates.
Added a tutorial on how to add fonts Added a tutorial to the README.md, explaining how to add fonts to tcpdf and therefore making them available in the Custom Certificate module. 2016-08-19 13:29:08 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`### Download the zip`
Added a tutorial on how to add fonts Added a tutorial to the README.md, explaining how to add fonts to tcpdf and therefore making them available in the Custom Certificate module. 2016-08-19 13:29:08 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`Visit the [Moodle plugins website](https://moodle.org/plugins/mod_customcert "Moodle plugins website") and download the zip corresponding to the version of Moodle you are using. Extract the zip and place the 'customcert' folder in the mod folder in your Moodle directory.`
Added a tutorial on how to add fonts Added a tutorial to the README.md, explaining how to add fonts to tcpdf and therefore making them available in the Custom Certificate module. 2016-08-19 13:29:08 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`## More information`
Added a tutorial on how to add fonts Added a tutorial to the README.md, explaining how to add fonts to tcpdf and therefore making them available in the Custom Certificate module. 2016-08-19 13:29:08 +00:00
#106 Minor tweaks to README.md 2017-04-28 02:42:55 +00:00			`Visit the [wiki page](https://docs.moodle.org/en/Custom_certificate_module "Wiki page") for more details. Also, it is a wiki, so please feel free to edit it. :)`
Added a tutorial on how to add fonts Added a tutorial to the README.md, explaining how to add fonts to tcpdf and therefore making them available in the Custom Certificate module. 2016-08-19 13:29:08 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`## License`
Added a tutorial on how to add fonts Added a tutorial to the README.md, explaining how to add fonts to tcpdf and therefore making them available in the Custom Certificate module. 2016-08-19 13:29:08 +00:00
#106 Updated README.md 2017-04-27 09:25:31 +00:00			`Licensed under the [GNU GPL License](http://www.gnu.org/copyleft/gpl.html).`