Skip to content

Commit 2cd7e82

Browse files
author
Yong Bakos
committed
Add license and contributing guide. Fixes #107
1 parent f6ef676 commit 2cd7e82

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing Guide
2+
3+
If you encounter a bug, please [create an issue](https://github.com/b-g/processing-sublime/issues) here on GitHub.
4+
5+
Contributions to this package are welcome. Consider looking at [current issues](https://github.com/b-g/processing-sublime/issues), past [commits](https://github.com/b-g/processing-sublime/commits/master), older [pull requests](https://github.com/b-g/processing-sublime/pulls?utf8=%E2%9C%93&q=) to get a feel for things, then fork the repository, create your own feature branch, make your changes, and send a pull request to the [develop](https://github.com/b-g/processing-sublime/tree/develop) branch of this repository.

LICENSE

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2016 Benedikt Groß
3+
4+
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:
5+
6+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7+
8+
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.

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Use Processing's _Tools > Install "processing-java"_ menu item after you have in
1515
This package assumes that you chose to install `processing-java` for all users (recommended). If you choose to install `processing-java` only in your home directory, then you have to slightly change the build script, see the comment in the file [Processing.sublime-build](https://github.com/b-g/processing-sublime/blob/master/Build%20Systems/Processing.sublime-build).
1616

1717
### Linux
18-
You will need to set your `PATH` to where your processing application is located, e.g.:
18+
You will need to set your `PATH` to where your processing application is located, e.g.:
1919
`export PATH=$PATH:/opt/processing/processing-2.0b4`
2020

21-
You also need to create an alias for `processing-java` in `/bin/` instead of `/usr/bin/`, e.g.:
21+
You also need to create an alias for `processing-java` in `/bin/` instead of `/usr/bin/`, e.g.:
2222
`sudo ln -s /opt/processing/processing-java /bin/processing-java`
2323

2424
### Windows
@@ -112,3 +112,6 @@ If you are new to Sublime I recommend the [Perfect Workflow in Sublime Text](htt
112112
- Syntax definition, snippet cleansing, Processing reference vs. sublime [diff tool](https://github.com/ybakos/processing-sublime-util), and _New Java Ant Project_ command: [Yong Joseph Bakos](http://yongbakos.com)
113113
- How to set custom shortcuts: [Raphaël de Courville](https://github.com/SableRaf)
114114
- Rebuild of the processing syntax highlighter: [Kyle Fleming](https://github.com/kylefleming)
115+
116+
See the [contributing guide](https://github.com/b-g/processing-sublime/blob/master/CONTRIBUTING.md) to learn about how to contribute to this project.
117+

0 commit comments

Comments
 (0)