Created Readme

Author: HexagonNico

Readme.md

@@ -0,0 +1,154 @@
+
+# VecMatLib
+
+VecMatLib provides simple data structures for vectors and matrices and an implementation of all their basic operations that can be integrated in any Java or Scala project.
+
+## Project goals
+
+The goal of VecMatLib is to provide easy-to-use and efficient linear algebra operations, needed by any 3D application.
+
+Vectors and matrices structures are written in Scala to make the best use possible of Scala's operator overloading.
+All methods with symbolic names have an alias for better interoperability with java.
+
+## Vector math
+
+All operations in VecMatLib are designed to **not** modify the object on which the operation is invoked to respect the principles of purity and immutability of functional programming.
+
+Scala example:
+
+```scala
+	var a = Vec3f(1.0f, 1.0f, 1.0f)
+	var b = Vec3f(0.5f, 0.5f, 0.5f)
+
+	// 'a' and 'b' will not change
+	val c = a + b
+
+	// Increase 'a' by 'b'
+	a = a + b
+```
+
+Java example:
+
+```java
+	Vec3f a = new Vec3f(1.0f, 1.0f, 1.0f);
+	Vec3f b = new Vec3f(0.5f, 0.5f, 0.5f);
+
+	// 'a' and 'b' will not change
+	Vec3f c = a.plus(b);
+
+	// Increase 'a' by 'b'
+	a = a.plus(b);
+```
+
+The Vector API offers integer, single-precision and double-precision vectors with all their basic operations.
+
+```scala
+	var a = Vec3f(1.0f, 1.0f, 1.0f)
+	var b = Vec3f(0.5f, 0.5f, 0.5f)
+
+	var dotProduct = a dot b
+	var normal = a.normalized
+	var reflection = b.reflect(normal)
+```
+
+```java
+	Vec3f a = new Vec3f(1.0f, 1.0f, 1.0f);
+	Vec3f b = new Vec3f(0.5f, 0.5f, 0.5f);
+
+	float dotProduct = a.dot(b);
+	Vec3d normal = a.normalized();
+	Vec3d reflection = b.reflect(normal);
+```
+
+## Matrix API
+
+With VecMatLib you can create matrices for geometric transformations such as translation, rotation, and scale.
+None of these operations modify the matrix on which they are called.
+
+```scala
+	var position = Vec4f(x, y, z, 1.0f)
+	val translation = Mat4f.translation(tx, ty, tz)
+
+	// will result in (x + tx, y + ty, z + tz, 1.0f)
+	position = translation * position
+```
+
+```java
+	Vec4f position = new Vec4f(x, y, z, 1.0f);
+	Mat4f translation = Mat4f.translation(tx, ty, tz);
+
+	// will result in (x + tx, y + ty, z + tz, 1.0f)
+	position = translation.multiply(position);
+```
+
+## Using with [LWJGL](https://lwjgl.org)
+
+VecMatLib can be used together with LWJGL to set uniform variables in shaders.
+
+```java
+	Vec3f lightPosition = new Vec3f(-3.0f, 10.0f, 6.0f);
+	int location = GL20.glGetUniformLocation(program, "light_position");
+	GL20.glUniform3f(location, lightPosition.x(), lightPosition.y(), lightPosition.z());
+```
+
+## Add VecMatLib to your project
+
+VecMatLib can be added to any Java or Scala project as a dependency using Jitpack.
+
+### Gradle
+
+```groovy
+	allprojects {
+		repositories {
+			...
+			maven { url 'https://jitpack.io' }
+		}
+	}
+```
+
+```groovy
+	dependencies {
+		implementation 'com.github.HexagonNico:VecMatLib:0.1'
+	}
+```
+
+### Maven
+
+```xml
+	<repositories>
+		<repository>
+			<id>jitpack.io</id>
+			<url>https://jitpack.io</url>
+		</repository>
+	</repositories>
+```
+
+```xml
+	<dependency>
+		<groupId>com.github.HexagonNico</groupId>
+		<artifactId>VecMatLib</artifactId>
+		<version>0.1</version>
+	</dependency>
+```
+
+### SBT
+
+```sbt
+	resolvers += "jitpack" at "https://jitpack.io"
+```
+
+```sbt
+	libraryDependencies += "com.github.HexagonNico" % "VecMatLib" % "0.1"
+```
+
+## Support the project
+
+VecMatLib was developed by a single person.
+
+Initially a university project, later completed and turned into a full project.
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/X8X87EZ87)
+
+## Contributing
+
+Your contributions are always welcome! Please submit a pull request or open an issue if you want to contribute with bug fixes, code improvements and better unit test coverage.

build.sbt

@@ -1,4 +1,4 @@
-ThisBuild / version := "0.1.0-SNAPSHOT"
+ThisBuild / version := "0.1"
 
 ThisBuild / scalaVersion := "2.13.10"