Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeMyst committed Mar 5, 2022
1 parent e485f7c commit 90ad842
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Dath

[![DUB](https://img.shields.io/dub/v/dath)](https://code.dlang.org/packages/dath)

A simple math library intended for games, written in D.

The reason for making this library is for personal projects, learning, and it simply being fun to make. As such, this library is a work in progress, the API might change, and the implementation of math functions is definitely a naive one, and performance isn't a huge factor as it's intended for small 2D games, though I will still try and improve performance when I can.
Expand All @@ -8,6 +10,12 @@ Inspiration and ideas from: [gfm](https://code.dlang.org/packages/gfm) and [gl3n

All functions are `nogc`.

## Usage

Add to your project: `dub add dath`.

Import: `import dath;`.

## Documentation

As the library is pretty small, all the documentation will be provided in this README file. You can also look in the unittests of each module for usage.
Expand Down
4 changes: 2 additions & 2 deletions dub.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"authors": [
"CodeMyst"
],
"copyright": "Copyright © 2020, codemyst",
"copyright": "Copyright © 2022, codemyst",
"dependencies": {
"fluent-asserts": "~>0.13.3",
"silly": "~>1.1.1"
},
"description": "math lib intended for games. still very much a work in progress.",
"description": "Math lib intended for games. Still very much a work in progress.",
"license": "MIT",
"name": "dath",
"targetType": "library"
Expand Down

0 comments on commit 90ad842

Please sign in to comment.