From 75d89c3ad9f4236d604450565a7524419fc743bf Mon Sep 17 00:00:00 2001 From: Dickson Law Date: Sat, 20 Apr 2019 22:23:59 -0400 Subject: [PATCH] Add license and readme --- LICENSE | 21 +++++++++++++++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b1b005f --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Dickson Law + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..80d5b6e --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# GMLinear v2.0.0 + +Matrix and vector library for GameMaker Studio 2.x + +## Introduction + +GMLinear is an implementation of matrix and vector operations in pure GML. You can use it to simplify many common calculations in 2D and 3D geometry and implement algorithms/formulas involving linear algebra. Hard-coded optimized functions are available for 2D, 3D and 4D vectors and 2x2, 3x3 and 4x4 matrices. + +## Requirements + +- GameMaker Studio 2.2.2 or above + +If you use GameMaker Studio 1.4, please see [GMLinear Legacy](https://github.com/dicksonlaw583/gmlinear-legacy). + +## Installation + +Download the latest version from [the YoYo Marketplace](http://marketplace.yoyogames.com/assets/8170/gmlinear). + +## Contributing to GMLinear + +- Clone this repository. +- Open the project in GameMaker Studio and make your additions/changes to the `GMLinear` extension. Also add corresponding tests to the `GMLinear_test` script group. +- Use F5 to run the test suite. A successful run should exit on its own without showing any errors (native platforms) or show a green background (HTML5-based platforms). +- Open a pull request [here](https://github.com/dicksonlaw583/gmlinear2/issues).