Add package: Urtellik UL.mpackage #448
Closed
+0
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Package information:
TemplateProject
TemplateProject by ShrinkingViolet
This is a template project created by muddler. It's meant to give you the basic skeleton to get started.
It is not a complete project, nor does it provide an example of every type of trigger scenario or keybinding corner case. It would make it even more difficult to clear out to make way for your own items.
It will properly muddle and create an mpackage, however.
For more detailed information on describing your triggers, scripts, etc in the json files, please see the muddler wiki
This space is where I would normally put the description of my package and what it does/why I made it. But if you have a README format you already like, feel free to ignore all this.
Installation
It's a good idea to provide installation instructions. I like to include a command they can copy/paste into the Mudlet commandline. Like
lua uninstallPackage("packageName") installPackage("https://somedomain.org/path/to/my/package/packageName.mpackage")
Usage
Brief introduction to the overall usage. Then break it down to specifics
Aliases
alias1 <param1>
alias 2
API
Final thoughts, how to contribute, thanks, things like that
I like to put anything which doesn't fit with the above stuff here, at the end. It keeps the documentation like stuff at the top.