-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a LICENSE and other changes for Open Sourcing
- Loading branch information
Dominic Dolan
committed
Oct 3, 2020
1 parent
1826065
commit c9a3cbb
Showing
4 changed files
with
60 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Introduction | ||
|
||
Thank you for considering contributing to Mechanica. | ||
|
||
This project is very new and it is just now being released as open source. | ||
For that reason we don't have a full cohesive plan just yet. We mainly | ||
just want to make sure everything is working the way we want it to. | ||
|
||
Saying that, there is still a lot of work to do going forward. | ||
So if you do have an idea or a suggestion, or you found a bug, | ||
feel free to create an issue in the issue tracker. | ||
|
||
# Filing Bug Reports | ||
|
||
When filing a bug report, make sure to include the following where necessary: | ||
|
||
1. What operating system are you using? | ||
2. What version of Kotlin are you using? | ||
3. What version of the JDK did you use to compile? | ||
4. What did you do and can you recreate the bug consistently? | ||
5. What did you expect to see or why do you think this is a bug? | ||
|
||
# Suggesting Features or Enhancements | ||
|
||
Because this is a very new project, there are a lot of | ||
features and enhancements to be added. | ||
|
||
Right now there is not a solid plan in place for what features we | ||
are looking for but if you have an idea feel free to create an issue | ||
and make sure to describe the reasons, motivation and benefits of such | ||
a feature |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License (MIT) | ||
|
||
Copyright (c) 2020 Dominic Dolan | ||
|
||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters