This plugin primary purpose is to be a good example of Osclass plugin and comes along with a full step-by-step explanations in a tutorial on how to develop Osclass plugins.
Build better-organized and coherent plugins for Osclass!
It's particularly meant to lay the foundations and give guidelines about:
- Directory structure: how to organize things;
- Naming and coding-style conventions;
- Useful tools;
This is no absolute specifications but guidelines to make better-organized and coherent plugins for Osclass!
Starter plugin usage
It's still a work in progress and needs some improvements to be easier to use as a starter plugin. It's still doable and will put you on the right tracks to kick off your own Osclass plugin.
Clone this repository to your
Fork, clone or download this repository:
git clone email@example.com:friends-of-osclass/madhouse_helloworld.git your_plugin_name
Edit plugin informations
/* Plugin Name: Madhouse HelloWorld Short Name: madhouse_helloworld Plugin URI: http://wearemadhouse.wordpress.com/2013/10/11/how-to-develop-osclass-plugins/ Description: A dummy plugin which is meant to be used as template. Version: 1.2.0 Author: Madhouse Author URI: http://wearemadhouse.wordpress.com/ Plugin update URI: madhouse-helloworld */
Search & Replace
Replace all occurences of
madhouse_helloworld by your own plugin name.
Beware! Be sure to take a closer look to Conventions and Guidelines part of the tutorial when choosing your Osclass plugin name.
Please use the following support channels:
GitHub issues for bug reports and feature requests.
Apache License 2.0. See LICENSE.