From 16ece012807d66d4506c026ceba1ec6bcb608e3a Mon Sep 17 00:00:00 2001 From: Ferdinand Majerech Date: Mon, 16 Feb 2015 13:53:14 +0100 Subject: [PATCH] README update --- README.html | 444 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 3 +- 2 files changed, 446 insertions(+), 1 deletion(-) create mode 100644 README.html diff --git a/README.html b/README.html new file mode 100644 index 0000000..f267aaf --- /dev/null +++ b/README.html @@ -0,0 +1,444 @@ + + + + + + +TinyEndian + + + +
+

TinyEndian

+ +https://travis-ci.org/kiith-sa/tinyendian.svg?branch=master +https://raw.githubusercontent.com/kiith-sa/tinyendian/master/code.dlang.org-shield.png +
+

Introduction

+

TinyEndian is a minimal endianness library for the D programming language. It has no +external dependencies, it only needs a D compiler and Phobos (standard library). +TinyEndian doesn't allocate memory and is fully @nogc to allow use in +high-performance code.

+

The API is not stable and may change in the future.

+
+
+

Features

+
    +
  • Swap byte order of 2- or 4-byte elements in an array in place.
    • +
  • Read a UTF-8, UTF-16 or UTF-32 buffer, determine its endianness using a UTF +byte-order-mark and convert it to system endianness in place.
    • +
  • No external dependencies.
    • +
  • pure, nothrow and @nogc.
    • +
+
+
+

Directory structure

+ ++++ + + + + + + + + + + + + + +
DirectoryContents
./This README file, license, DUB package file.
./sourceSource code.
+
+
+

Usage

+

Assuming you use dub, add this line:

+
+"tinyendian": { "version" : "~>0.1.0" }
+
+

to the "dependencies" in your project's dub.json.

+

If you don't use dub, you can directly copy the source/tinyendian.d file into your +project.

+

TinyEndian requires DMD 2.066 or equivalent GDC/LDC.

+

API documentation can be found at +DDocs.org.

+
+
+

License

+

TinyEndian is released under the terms of the +Boost Software License 1.0. +This license allows you to use the source code in your own projects, open source +or proprietary, and to modify it to suit your needs. However, in source +distributions, you have to preserve the license headers in the source code and +the accompanying license file.

+

Full text of the license can be found in file LICENSE_1_0.txt and is also +displayed here:

+
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+
+
+

Credits

+

TinyEndian was created by Ferdinand Majerech aka Kiith-Sa kiithsacmp[AT]gmail.com .

+

Parts of code based on the std.stream Phobos module.

+

D:YAML was created using Vim and DMD Linux Mint as a YAML parsing library for the D +programming language.

+
+
+ + diff --git a/README.rst b/README.rst index b13a038..a1e5f0f 100644 --- a/README.rst +++ b/README.rst @@ -54,7 +54,8 @@ project. TinyEndian requires DMD 2.066 or equivalent GDC/LDC. -Open ``source/tinyendian.d`` to read the API documentation. +`API documentation `_ can be found at +`DDocs.org `_. -------