Skip to content

Rewrite README for discovery and onboarding #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
StevenMagnet wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Rewrite README for discovery and onboarding #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 33 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,47 @@
# Aether miscpp library
# Æthernet C++ Utilities

Collection of miscelnaus utils widely used in most aether c++ libraries.
Header-only C++20 utilities shared by Æthernet C++ projects. This is an internal building block published separately for reuse and testing; it is not an Æthernet network client.

## Usage

Use [CPM](https://github.com/cpm-cmake/CPM.cmake) to integrate it with your project:
## Add with CPM.cmake

```cmake
include(cmake/CPM.cmake)

CPMAddPackage("gh:aethernetio/aether-miscpp#main")
...
CPMAddPackage(
NAME aether-miscpp
GITHUB_REPOSITORY aethernetio/aether-miscpp
GIT_TAG main
)

target_link_library(${target_name} PRIVATE aether::miscpp)
target_link_libraries(your_target PRIVATE aether::miscpp)
```

For reproducible builds, pin `GIT_TAG` to a reviewed commit SHA.

## Requirements

- CMake 3.16 or newer;
- a C++20 compiler.

## Build and test

Configure, build and test Cmake project as usual:
```bash
git clone https://github.com/aethernetio/aether-miscpp.git
cd aether-miscpp

cmake -S . -B build -DAE_BUILD_TESTS=ON
cmake --build build --parallel
ctest --test-dir build --output-on-failure
```

When built as the root project, tests and installation are enabled by default. When included by another CMake project, use `AE_BUILD_TESTS` and `AE_INSTALL` to control them.

## CMake target

```sh
mkdir build
cd build
cmake ..
cmake --build .
ctest .
```cmake
aether::miscpp
```

./CMakeLists.txt automatically detects if this project build on its own or as part of another project.
In the first case it also automatically enable tests and installation.
In the second case you are free to enable it by options `AE_BUILD_TESTS` and `AE_INSTALL`.
## License

Apache License 2.0. See [LICENSE](LICENSE).
Loading