What is Avo?

Avo is a light, modern C++20 library with a clean design containing various modular components useful for writing applications.

The library was initially written in C++17, but now it is being rewritten from scratch in C++20 and with a better design that is less object oriented.

It can currently be built by GCC and MSVC, but not Clang because it does not yet support all the features used.

Avo consists of:

• Various modern utilities
• Mathematical types and functions
• A windowing library
• A graphics drawing library (not yet)

Aims and features

Note: The new version of this library has only begun development and is very far from finished.

• The design of the library is modular and different parts can be used (and tested) separately.
• The library utilizes different programming paradigms and avoids inheritance hierarchies to be more flexible.
• Interfaces are hard to misuse and as many errors as possible are caught at compile time.
• Library code follows C++ Core Guidelines.
• Written with modules when build systems and compilers have good support for modules.
• Support for Windows, Linux, and MacOS.
• UTF-8 by default.
• Free from warnings with all useful warning flags turned on.
• Modern CMake integration.

CMake usage

Dependencies

Avo currently only depends on native libraries and the C++ standard library.

Building and installing

Below are the basic commands to build and install Avo using CMake. You don't have to do this if you want to use it as a subproject or with FetchContent. You might have to run the install command as administrator on Windows or add sudo to it on Linux/MacOS.

To help CMake find dependencies you might want to add a CMAKE_PREFIX_PATH or CMAKE_TOOLCHAIN_FILE to the configuration command.

If you are making changes to the library, use one of the toolchain files in the cmake directory to add warning flags. These automatically also include the VCPKG toolchain file if the environment variable VCPKG_ROOT is defined.

git clone https://github.com/avocadoboi/avo.git
mkdir avo/build
cd avo/build
cmake ..
cmake --build . --target avo --config Release
cmake --install .

Using as installation

find_package(Avo REQUIRED)
target_link_libraries(target PRIVATE Avo::avo)

Using as subproject

add_subdirectory(external/avo)
target_link_libraries(target PRIVATE Avo::avo)

Using FetchContent to download

include(FetchContent)

FetchContent_Declare(
  Avo
  GIT_REPOSITORY https://github.com/avocadoboi/avo.git
  GIT_TAG cpp20-rewrite
)
FetchContent_MakeAvailable(Avo)

target_link_libraries(target PRIVATE Avo::avo)