Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# `zeus::expected`

[![Tests Workflow](https://github.com/zeus-cpp/expected/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/zeus-cpp/expected/actions/workflows/tests.yml?query=branch%3Amain)
[![GitHub Release](https://img.shields.io/github/v/release/zeus-cpp/expected?color=green)](https://github.com/zeus-cpp/expected/releases)
[![Conan Center](https://img.shields.io/conan/v/zeus_expected)](https://conan.io/center/recipes/zeus_expected)

Backporting `std::expected` to C++17.

## Features
Expand All @@ -25,33 +29,27 @@ Enhancements:

## Compiler supports

Any compiler that supports C++17 and later should work.
Usage against higher language standard is also supported, in which you'll gain some benefits (e.g. better constexpr).
Any compiler that supports C++17 should work.

While heavily tested under MSVC and C++20, it's only tested slightly under C++17, since newly-made.
May assume that it could just work if it compiled successfully.
Feedbacks are welcome.
Higher language standards are also supported, which can provide benefits such as enhanced constexpr capabilities.

Table of known compiler status.
List of known compiler supported:

| Planned | Status |
| ------------------- | --------------- |
| MSVC v142 and later | Fully tested |
| GCC 8 and later | Slightly tested |
+ MSVC v142 and later
+ GCC 8 and later

Feedbacks are welcome.

## Building and testing

[Catch2](https://github.com/catchorg/Catch2) is required to build the tests.
You may choose any preferred package manager to introduce the requirements. Here is the `conan` one.
You may choose any preferred package manager to introduce the requirements. Here is a `conan` way.

```
```bash
# install the requirements
conan install . -s build_type=Debug -b missing
# glance the cmake preset names
cmake --list-presets
cmake --build --list-presets
ctest --list-presets
# configure, build and test per preset names
# configure, build and test with cmake
# ...
```

## Acknowledgements
Expand Down
2 changes: 1 addition & 1 deletion include/zeus/expected.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#include <utility>

#define ZEUS_EXPECTED_VERSION_MAJOR 1
#define ZEUS_EXPECTED_VERSION_MINOR 2
#define ZEUS_EXPECTED_VERSION_MINOR 3
#define ZEUS_EXPECTED_VERSION_PATCH 0

#if defined(_MSVC_LANG)
Expand Down