docpp/README.md
Jacob f30f1431fd Add Arch packaging.
TODO: Gentoo, Debian and Red Hat packaging.
2024-05-13 15:09:20 +02:00

1.6 KiB

docpp

action

Small C++ library for generating XML, HTML and CSS.

Features

  • HTML, CSS and XML document generation and deserialization
  • Sensible indentation for pretty-formatting.
  • Modern C++ API
  • No dependencies, other than the standard library
  • Windows, macOS, Linux and *BSD support
  • LGPL license

Not yet implemented

  • HTML/XML/CSS serialization (parsing from e.g. file)

Installation

To install the library, you can utilize the provided CMakeLists.txt file:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
cmake --build .
cmake --install . --prefix /usr

This will install the library to /usr/lib and the headers to /usr/include/docpp. If you use Arch Linux, you can install the library by specifying -DBUILD_ARCH=ON to the cmake build command. This requires makepkg. If you don't specify anything, a PKGBUILD will be generated in the build directory. If you use Gentoo Linux, an ebuild will automatically be generated in the build directory. If you use a package manager that uses DEB or RPM packages, you can enable the BUILD_DEB or BUILD_RPM options to generate a package, which will be placed in the build directory.

Usage

Just include docpp.hpp in your project and link against the library. Examples can be found in the examples directory.

License

This project is licensed under the GNU Lesser General Public License v3.0 - see the LICENSE file for details.

Code of Conduct

None. Just don't blow up my house. And, don't ask me to rewrite it in Rust.