|
1 | | -# purescript-float32 |
| 1 | +# Float32 |
2 | 2 |
|
3 | | -[](https://travis-ci.org/athanclark/purescript-float32) |
| 3 | +[](https://github.com/purescript-contrib/purescript-float32/actions?query=workflow%3ACI+branch%3Amain) |
| 4 | +[](https://github.com/purescript-contrib/purescript-float32/releases) |
| 5 | +[](https://pursuit.purescript.org/packages/purescript-float32) |
| 6 | +[](https://github.com/jamesdbrock) |
4 | 7 |
|
5 | | -This data type is just a wrapper around `Number`, where |
6 | | -entering into the type can only be done with `Math.fround()`. |
| 8 | +The library summary hasn't been written yet (contributions are welcome!). The library summary describes the library's purpose in one to three sentences. |
7 | 9 |
|
8 | | -It supports all of the features of `Number`. |
| 10 | +## Installation |
9 | 11 |
|
10 | | -## Development |
| 12 | +Install `float32` with [Spago](https://github.com/purescript/spago): |
11 | 13 |
|
12 | | -To test the package, `spago -x test.dhall test`. |
| 14 | +```sh |
| 15 | +spago install float32 |
| 16 | +``` |
| 17 | + |
| 18 | +## Quick start |
| 19 | + |
| 20 | +The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the [docs directory](./docs). |
| 21 | + |
| 22 | +## Documentation |
| 23 | + |
| 24 | +`float32` documentation is stored in a few places: |
| 25 | + |
| 26 | +1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-float32). |
| 27 | +2. Written documentation is kept in the [docs directory](./docs). |
| 28 | +3. Usage examples can be found in [the test suite](./test). |
| 29 | + |
| 30 | +If you get stuck, there are several ways to get help: |
| 31 | + |
| 32 | +- [Open an issue](https://github.com/purescript-contrib/purescript-float32/issues) if you have encountered a bug or problem. |
| 33 | +- [Search or start a thread on the PureScript Discourse](https://discourse.purescript.org) if you have general questions. You can also ask questions in the `#purescript` and `#purescript-beginners` channels on the [Functional Programming Slack](https://functionalprogramming.slack.com) ([invite link](https://fpchat-invite.herokuapp.com/)). |
| 34 | + |
| 35 | +## Contributing |
| 36 | + |
| 37 | +You can contribute to `float32` in several ways: |
| 38 | + |
| 39 | +1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-float32/issues). We'll do our best to work with you to resolve or answer it. |
| 40 | + |
| 41 | +2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions. |
| 42 | + |
| 43 | +3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed. |
0 commit comments