cazagen/octoprint-ldap
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some fixes to README.md

Browse Source
This commit is contained in:
Gina Häußge 2015-03-31 18:34:17 +02:00
parent d1849cf74b
commit 50042c1ccf
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -3,9 +3,9 @@ OctoPrint Plugin Skeleton
This is a basic plugin skeleton that you can use as a basis for your own OctoPrint plugin. This is a basic plugin skeleton that you can use as a basis for your own OctoPrint plugin.
You can copy the files to a folder of your choice, or just clone this repository, renaming it in the process, and check You can copy the files to a folder of your choice, or just clone this repository, renaming it in the process. Then
it out. Then modify ``setup.py`` to fit your plugin, rename ``octoprint_skeleton`` accordingly and finally implement modify ``setup.py`` to fit your plugin, rename ``octoprint_skeleton`` accordingly and finally implement your plugin
your plugin under ``octoprint_<plugin identifier>``. under ``octoprint_<plugin identifier>``.
Example Usage Example Usage
------------- -------------
@ -41,7 +41,7 @@ class HelloWorldPlugin(octoprint.plugin.StartupPlugin):
self._logger.info("Hello World!") self._logger.info("Hello World!")
__plugin_name__ = "Hello World" __plugin_name__ = "Hello World"
__plugin_implementations__ = [HelloWorldPlugin()] __plugin_implementation__ = HelloWorldPlugin()
``` ```
Test it (e.g. via ``python setup.py develop``). If everything works, write a nice ``README.md``, replacing the existing one. Test it (e.g. via ``python setup.py develop``). If everything works, write a nice ``README.md``, replacing the existing one.
@ -53,5 +53,5 @@ Commit your code, then push it to your plugin's repository (this assumes you alr
git push -u origin master git push -u origin master
Congratulations, you are now the proud maintainer of a new OctoPrint plugin! :) Don't forget to add an entry to the Congratulations, you are now the proud maintainer of a new OctoPrint plugin! :) Don't forget to add an entry to the
[wiki](https://github.com/foosel/OctoPrint/wiki#plugins) once it's suitable for general consumption, so that other's [wiki](https://github.com/foosel/OctoPrint/wiki#plugins) once it's suitable for general consumption, so that others
may find it! may find it!