github.com/unn4m3d/crystaledge

A pure Crystal Vector Math library

27 stars
0 dependents
License: MIT

Nothing has been indexed for 0.2.0 yet. The tag is recorded, its shard.yml has not been read, so the manifest and dependency list below are empty because they are unknown rather than because they are absent.

Installation

# Add this to your shard.yml
dependencies:
  crystaledge:
    github: unn4m3d/crystaledge
    version: ~> 0.2.0

Then run:

shards install

shard.yml

No shard.yml has been indexed for 0.2.0. You can read it on the repository.

Dependencies

Unknown: the shard.yml for this version has not been read yet.

Documentation

Read the API documentation

Generated from the source of the current release. The first visit to a release that has never been documented starts its build.

README

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# crystaledge
[![Build Status](https://travis-ci.org/unn4m3d/crystaledge.svg?branch=master)](https://travis-ci.org/unn4m3d/crystaledge)

Pure Crystal vector math library (**WIP**)


## Installation


Add this to your application's `shard.yml`:

```yaml
dependencies:
  crystaledge:
    github: unn4m3d/crystaledge
```

## Development

TODO List:
- [x] Vector2 math
  - [x] Vector2 * Matrix3
  - [x] Vector2 tests
  - [x] Vector2 docs
  - [ ] "Dangerous" versions of Vector2 methods
- [x] Vector3 math
  - [x] Vector3 * Matrix4
  - [x] Vector3 rotation
  - [x] Vector3 reflection
  - [x] Vector3 tests
  - [ ] Vector3 docs
  - [ ] "Dangerous" versions of Vector3 methods
- [x] Vector4 math
  - [x] Vector4 tests
  - [ ] Vector4 docs
  - [ ] "Dangerous" versions of Vector4 methods
- [x] Matrix3 math
  - [x] Matrix3 tests
  - [ ] Matrix3 docs
- [x] Matrix4 math
  - [x] Matrix4 tests
  - [ ] Matrix4 docs
- [x] Quaternion
  - [x] Quaternion tests
  - [ ] Quaternion docs

## Contributing

1. Fork it ( https://github.com/unn4m3d/crystaledge/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [unn4m3d](https://github.com/unn4m3d) - creator, maintainer
- [l3kn](https://github.com/l3kn)