Short description of your library, why it's useful, some examples, pictures or videos.
IMPORTANT: Modify
LICENSE
with your preferred license text. If you are fine with MIT, add your name and year.What the sections below should be used for:
## Installation
: Leave this section un-edited unless you have some specific additional installation procedure.
## Testing
: If your library is a code library, omit theAnd connect to localhost:7777 to test.
note.And finally, maintaining
VERSION
:
- Follow Semantic Versioning
- When you release a new version, update
VERSION
andgit tag
it (usemake release
if you can)- Versioning is important for sampctl to use the version control features
Happy Pawning!
Simply install to your project:
sampctl package install Owner/library
Include in your code and begin using the library:
#include <library>
Write your code documentation or examples here. If your library is documented in the source code, direct users there. If not, list your API and describe it well in this section. If your library is passive and has no API, simply omit this section.
To test, simply run the package:
sampctl package run
And connect to localhost:7777
to test.