libostd/README.md

39 lines
1.5 KiB
Markdown
Raw Normal View History

2015-04-04 21:12:10 +02:00
# octastd
2015-04-06 00:10:44 +02:00
OctaSTD is a collection of C++ utilities to aid the upcoming OctaForge C++
API. It provides containers (dynamic arrays etc) as well as other utilities.
2015-04-23 19:47:33 +02:00
2015-05-18 03:13:16 +02:00
Documentation for OctaSTD can be found at https://wiki.octaforge.org/docs/octastd.
2015-04-23 19:47:33 +02:00
It utilizes C++11. It also implements equivalents of certain C++14 library
features that are possible to implement with the C++11 language. It does not
go beyond C++11 level when it comes to core language features.
## Supported compilers
Compiler | Version
-------- | -------
gcc/g++ | 4.8+
2015-04-24 19:16:35 +02:00
clang | 3.3+
2015-04-23 19:47:33 +02:00
Other C++11 compliant compilers might work as well. OctaSTD does not utilize
compiler specific extensions except certain builtin type traits - to implement
traits that are not normally possible to implement without compiler support.
OctaSTD does not provide fallbacks for those traits. The compiler is expected
2015-05-06 20:54:20 +02:00
to support these builtins. So far the 2 above-mentioned compilers support them
(MSVC++ supports most of these as well).
MSVC++ is currently unsupported. It is likely that it will never be supported,
as it seems that MS will start supporting Clang in Visual Studio; however,
if that does not happen and the MS C++ compiler gains the required features,
2015-09-09 20:51:33 +02:00
support will be added.
## Supported operating systems
Currently supported OSes in OctaSTD are Linux, FreeBSD and OS X. Other
systems that implement POSIX API will also work (if they don't, bug reports
are welcome).
Windows is supported at least with the MinGW (gcc) and Clang compilers. MS
Visual Studio is currently unsupported.