Skip to content

Commit

Permalink
Added a LICENSE and other changes for Open Sourcing
Browse files Browse the repository at this point in the history
  • Loading branch information
Dominic Dolan committed Oct 3, 2020
1 parent 1826065 commit c9a3cbb
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 3 deletions.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
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
21 changes: 21 additions & 0 deletions LICENSE
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.

9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
## Mechanica, a 2D Game Engine in Kotlin

A powerful 2D Game Engine written in Kotlin. This project is still under development and it is not
thoroughly tested or documented but feel free to try it out nonetheless
thoroughly tested or documented but feel free to try it out nonetheless.

Get started coding games by checking out the [Wiki](https://github.com/DominicDolan/Mechanica/wiki)
or consider [Contributing](https://github.com/DominicDolan/Mechanica/blob/master/CONTRIBUTING.md)

### Building from source with Gradle

### Setting up the project with Gradle
Clone or download the repository and build with gradle.

Building it will require java 12 or later and note that later versions of Java require the latest version of Gradle.
Expand Down
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ val supplementaryLwjgl: DependencyHandlerScope.() -> Unit = {

allprojects {
group = "com.mechanica.engine"
version = 1.0
version = 0.1

repositories {
// Use jcenter for resolving your dependencies.
Expand Down

0 comments on commit c9a3cbb

Please sign in to comment.