https://github.com/joellefkowitz/linearity
Minimal 2D vector space interfaces.
https://github.com/joellefkowitz/linearity
area coordinates position vector
Last synced: 8 months ago
JSON representation
Minimal 2D vector space interfaces.
- Host: GitHub
- URL: https://github.com/joellefkowitz/linearity
- Owner: JoelLefkowitz
- License: mit
- Created: 2024-04-30T13:43:05.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-27T19:33:30.000Z (over 1 year ago)
- Last Synced: 2024-10-05T21:41:30.767Z (12 months ago)
- Topics: area, coordinates, position, vector
- Language: TypeScript
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Linearity
Minimal 2D vector space interfaces.
## Installing
```bash
npm install linearity
```
## Documentation
Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/linearity).
## Tooling
### Dependencies
To install dependencies:
```bash
yarn install
```
### Tests
To run tests:
```bash
yarn test
```
### Documentation
To generate the documentation locally:
```bash
yarn docs
```
### Linters
To run linters:
```bash
yarn lint
```
### Formatters
To run formatters:
```bash
yarn format
```
## Contributing
Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.
This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).
Bump2version is used to version and tag changes. For example:
```bash
bump2version patch
```
### Contributors
- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work
## Remarks
Lots of love to the open source community!
