Skip to content

Commit

Permalink
Updated README. Added LICENSE and CONTRIBUTING.
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Stevens committed Mar 22, 2014
1 parent 2074de7 commit 53c8896
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 6 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to Pointshop

Looking to contribute something to Pointshop? **Here's how you can help.**

## Reporting issues

We only accept issues that are bug reports or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Pointshop core. Please read the following guidelines before opening any issue.

1. **Search for existing issues.** We get a lot of duplicate issues, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
2. **Create an isolated and reproducible test case.** Be sure the problem exists in Pointshop's code.
3. **Share as much information as possible.** Include operating system and version, version of Pointshop, customized or vanilla build, etc. where appropriate. Also include steps to reproduce the bug.

## Pull requests

- Test your changes before hand, make sure they work with a clean Pointshop installation.
- Try not to pollute your pull request with unintended changes--keep them simple and small

## Coding standards

- No semicolons
- Four spaces for indentation, never tabs.
- Use descriptive variable naming, lowerCamelCase for locals, UpperCamelCase for public.
- Don't pollute _G or PS tables.
- "Attractive"

## License

By contributing your code, you agree to license your contribution under the terms of the MIT: https://github.com/adamdburton/pointshop/blob/master/LICENSE
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2014 Adam Burton, Matt Stevens

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
64 changes: 58 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,62 @@
PointShop by _Undefined
=========
# Pointshop

PointShop is a shop system for Garry's Mod 13 developed by _Undefined. The original version was created over 2 years ago in November 2010, and has now been re-created from scratch for Garry's Mod 13 with a few new features.
Pointshop is a shop system for Garry's Mod, created and maintained by [Adam '_Undefined' Burton](http://burt0n.net/) and ['Handsome' Matt Stevens](http://handsomematt.co.uk).

See http://pointshop.burt0n.net for more information.
## Quick start

Feel free to send a pull request, but please do not update thepointshop_build.txt unless you are providing a major update or security fix.
Two quick start options are available:

![PointShop](http://puu.sh/1zkWC)
* [Download the latest release](https://github.com/adamdburton/pointshop/releases/tag/v1.0.0).
* Clone the repo: `git clone https://github.com/adamdburton/pointshop.git`.

## Bugs and feature requests

Have a bug or a feature request? [Please open a new issue](https://github.com/adamdburton/pointshop/issues). Make sure you follow our [contributing guidelines](https://github.com/adamdburton/pointshop/blob/master/CONTRIBUTING.md).

## Documentation

See the wiki pages.

## Contributing

Please read through our [contributing guidelines](https://github.com/adamdburton/pointshop/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.

## Community

* Follow [@adamdburton on Twitter](https://twitter.com/adamdburton).
* Follow [@_HandsomeMatt on Twitter](https://twitter.com/_HandsomeMatt).
* Have a question that's not a feature request or bug report? [Ask on the Facepunch thread.](http://facepunch.com/threads/1286577)

## Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Pointshop will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

`<major>.<minor>.<patch>`

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit [http://semver.org/](http://semver.org/).

## Authors

**Adam '_Undefined' Burton**

+ [http://burt0n.net](http://burt0n.net/)
+ [http://twitter.com/adamdburton](http://twitter.com/adamdburton)
+ [http://github.com/adamdburton](http://github.com/adamdburton)

**'Handsome' Matt Stevens**

+ [http://handsomematt.co.uk](http://handsomematt.co.uk)
+ [http://twitter.com/_HandsomeMatt](http://twitter.com/_HandsomeMatt)
+ [http://github.com/HandsomeMatt](http://github.com/HandsomeMatt)

## Copyright and license

Copyright 2014 Adam Burton under [the MIT license](LICENSE).

0 comments on commit 53c8896

Please sign in to comment.