diff --git a/README.md b/README.md index 12fd58a..deb48f1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ -# ConformalLabpp +# conformallab++ -A modern C++ library for discrete conformal geometry and Möbius‑based mesh transformations. \ No newline at end of file +conformallab++ is a modern C++ reimplementation of the ConformalLab software by Stefan Sechelmann for experiments in discrete conformal geometry and related mesh transformations. + +It builds on well‑established open‑source libraries such as **CGAL**, **Eigen**, and **Boost** for robust geometric data structures and efficient numerical computations, and uses single‑header libraries **CLI11** and **json.hpp** for a lightweight command‑line interface and configuration handling. + +## Status + +This project is in an early prototype stage. +API, file formats and command‑line interface are all subject to change. + +## Features (placeholder) + +- Discrete conformal geometry utilities (placeholder) +- Mesh and graph data structures built on CGAL (placeholder) +- Linear algebra and optimization routines using Eigen (placeholder) +- High‑level operations and helpers based on Boost (placeholder) +- Command‑line tools with CLI11 and JSON configuration (placeholder) + +## Getting started + +### Prerequisites + +- A C++20 compiler (e.g. `g++` or `clang++`) +- CMake (version X.Y or newer, placeholder) +- CGAL, Eigen, and Boost installed and discoverable by CMake + +### Clone the repository + +```bash +git clone https://codeberg.org/user2595/ConformalLabpp +cd conformallabpp +git submodule update --init --recursive +``` + +### Configure and build +```bash +cmake -S . -B build -DCMAKE_BUILD_TYPE=Release +cmake --build build +Run a simple example +``` +```bash +# ./build/bin/conformallabpp +(Example command, to be adapted once the first tools are implemented.) +``` +### License +conformallabpp is released under the MIT License (see LICENSE).