third_party/nlio/repo/README.md

   1 [![Build Status][nlio-travis-svg]][nlio-travis]
   2 [![Coverage Status][nlio-codecov-svg]][nlio-codecov]
   3
   4 Nest Labs Memory Mapped I/O
   5 ===========================
   6
   7 # Introduction
   8
   9 Nest Labs Memory Mapped I/O (NLIO) is designed to provide both C
  10 and C++ language bindings to macros and functions for:
  11
  12 1. Determining, at both compile- and run-time, the byte ordering
  13    of the target system.
  14 2. Performing in place byte-swapping of compile-time constants
  15    via the C preprocessor as well as functions for performing
  16    byte-swapping by value and in place by pointer for 16-, 32-, and
  17    64-bit types.
  18 3. Safely performing simple, efficient memory-mapped accesses,
  19    potentially to unaligned memory locations, with or without byte
  20    reordering, to 8-, 16-, 32-, and 64-bit quantities. Functions
  21    both with and without pointer management are also available.
  22
  23 [nlio-travis]: https://travis-ci.com/nestlabs/nlio
  24 [nlio-travis-svg]: https://travis-ci.com/nestlabs/nlio.svg?branch=master
  25 [nlio-codecov]: https://codecov.io/gh/nestlabs/nlio
  26 [nlio-codecov-svg]: https://codecov.io/gh/nestlabs/nlio/branch/master/graph/badge.svg
  27
  28 # Interact
  29
  30 There are numerous avenues for nlio support:
  31
  32   * Bugs and feature requests — [submit to the Issue Tracker](https://github.com/nestlabs/nlio/issues)
  33   * Google Groups — discussion and announcements
  34     * [nlio-announce](https://groups.google.com/forum/#!forum/nlio-announce) — release notes and new updates on nlio
  35     * [nlio-users](https://groups.google.com/forum/#!forum/nlio-users) — discuss use of and enhancements to nlio
  36
  37 # Versioning
  38
  39 nlio follows the [Semantic Versioning guidelines](http://semver.org/)
  40 for release cycle transparency and to maintain backwards compatibility.
  41
  42 # License
  43
  44 nlio is released under the [Apache License, Version 2.0 license](https://opensource.org/licenses/Apache-2.0).
  45 See the `LICENSE` file for more information.