|
1 | 1 | # UnixMmap |
2 | 2 |
|
3 | | -[](https://github.com/jmert/UnixMmap.jl/actions) |
| 3 | +| **Build Status** | |
| 4 | +|:------------------------------------------------------------:| |
| 5 | +| [![][ci-img]][ci-url] | |
4 | 6 |
|
5 | 7 | `UnixMmap` is an alternative to the Julia standard library's `Mmap`, with the purpose of |
6 | | -exposing the Unix memory-mapping interface. |
| 8 | +exposing the Unix memory-mapping interface. |
| 9 | + |
| 10 | +### Installation and usage |
| 11 | + |
| 12 | +This library is **not** registered in Julia's [General registry][General.jl], |
| 13 | +so the package must be installed either by cloning it directly: |
| 14 | + |
| 15 | +``` |
| 16 | +(@v1.6) pkg> add https://github.com/jmert/UnixMmap.jl |
| 17 | +``` |
| 18 | + |
| 19 | +or by making use of my [personal registry][Registry.jl]: |
| 20 | + |
| 21 | +``` |
| 22 | +(@v1.6) pkg> registry add https://github.com/jmert/Registry.jl |
| 23 | +(@v1.6) pkg> add UnixMmap |
| 24 | +``` |
| 25 | + |
| 26 | +After installing, just load like any other Julia package: |
| 27 | + |
| 28 | +``` |
| 29 | +julia> using UnixMmap |
| 30 | +``` |
| 31 | + |
| 32 | +[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg |
| 33 | +[docs-stable-url]: https://jmert.github.io/UnixMmap.jl/stable |
| 34 | +[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg |
| 35 | +[docs-dev-url]: https://jmert.github.io/UnixMmap.jl/dev |
| 36 | + |
| 37 | +[ci-img]: https://github.com/jmert/UnixMmap.jl/workflows/CI/badge.svg |
| 38 | +[ci-url]: https://github.com/jmert/UnixMmap.jl/actions |
| 39 | + |
| 40 | +[codecov-img]: https://codecov.io/gh/jmert/UnixMmap.jl/branch/master/graph/badge.svg |
| 41 | +[codecov-url]: https://codecov.io/gh/jmert/UnixMmap.jl |
| 42 | + |
| 43 | +[General.jl]: https://github.com/JuliaRegistries/General |
| 44 | +[Registry.jl]: https://github.com/jmert/Registry.jl |
0 commit comments