Skip to content

Commit

Permalink
Stubs for CHANGELOG, README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
tuupola committed May 15, 2017
1 parent 40702ae commit f0bd5e9
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to this project will be documented in this file, in reverse chronological order by release.

## 0.1.0 - unreleased

Initial release with basic support for trilaterating three points.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# The MIT License (MIT)

Copyright (c) 2017 Mika Tuupola <tuupola@appelsiini.net>

> 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.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Trilateration

[![Latest Version](https://img.shields.io/packagist/v/tuupola/trilateration.svg?style=flat-square)](https://packagist.org/packages/tuupola/trilateration)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://img.shields.io/travis/tuupola/trilateration/master.svg?style=flat-square)](https://travis-ci.org/tuupola/trilateration)
[![HHVM Status](https://img.shields.io/hhvm/tuupola/trilateration.svg?style=flat-square)](http://hhvm.h4cc.de/package/tuupola/trilateration)
[![Coverage](http://img.shields.io/codecov/c/github/tuupola/trilateration.svg?style=flat-square)](https://codecov.io/github/tuupola/trilateration)

PHP implementation of [Trilateration](https://en.wikipedia.org/wiki/Trilateration) algorithm.

## Install

Install the library using [Composer](https://getcomposer.org/).

``` bash
$ composer require tuupola/trilateration
```
## Usage

Here be dragons.

## Testing

You can run tests either manually or automatically on every code change. Automatic tests require [entr](http://entrproject.org/) to work.

``` bash
$ composer test
```
``` bash
$ brew install entr
$ composer watch
```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email tuupola@appelsiini.net instead of using the issue tracker.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 comments on commit f0bd5e9

Please sign in to comment.