diff --git a/README b/README deleted file mode 100644 index 2039ba9..0000000 --- a/README +++ /dev/null @@ -1,29 +0,0 @@ -Boost Endian library - -The Endian library is included in Boost release 1.58.0 and later. - -See http://boostorg.github.io/endian to browse the documentation without having to -download the library or install Boost. - -To experiment with the Endian library, various other boost libraries must be -available. So you need to install Boost or clone a current version of boostorg/boost -if you have not already done so. - -Boost.Endian is a header-only library, so there is no need to run a build -for it, although you may need to do a "b2 headers". - -If your clone of boost is already in place, please remember to: - - cd boost - git pull - git submodule update --init - git submodule update - ./b2 headers - -On Windows, "./" is unnecessary. - ---------------------------- -Copyright Beman Dawes, 2013 - -Distributed under the Boost Software License, Version 1.0. -http://www.boost.org/LICENSE_1_0.txt \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..cbd15e2 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Boost.Endian + +The Endian library provides facilities for dealing with +[endianness](https://en.wikipedia.org/wiki/Endianness). +It's part of Boost since release 1.58.0. See +[the documentation](http://boost.org/libs/endian) for more information. + +## Supported compilers + +* g++ 4.4 or later +* clang++ 3.3 or later +* Visual Studio 2008 or later + +Tested on [Travis](https://travis-ci.org/boostorg/endian/) and +[Appveyor](https://ci.appveyor.com/project/pdimov/endian/). + +## License + +Distributed under the +[Boost Software License, Version 1.0](http://boost.org/LICENSE_1_0.txt).