docpp/README.md

# docpp

![action](https://github.com/speediegq/docpp/actions/workflows/cmake-multi-platform.yml/badge.svg)

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:

```sh
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](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.
Initial commit 2024-05-05 23:31:42 +02:00			`# docpp`

Add CI badge. 2024-05-06 00:31:29 +02:00			`![action](https://github.com/speediegq/docpp/actions/workflows/cmake-multi-platform.yml/badge.svg)`

Initial commit 2024-05-05 23:31:42 +02:00			`Small C++ library for generating XML, HTML and CSS.`

Change the behavior of FORMATTING_PRETTY to include tabs. FORMATTING_NEWLINE can be used if you want to preserve the old behavior. 2024-05-07 17:26:11 +02:00			`## 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)`

Initial commit 2024-05-05 23:31:42 +02:00			`## Installation`

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

			```sh
			`mkdir build`
			`cd build`
Add docpp.pc file, allowing pkg-config to find docpp. 2024-05-13 02:00:40 +02:00			`cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr`
Initial commit 2024-05-05 23:31:42 +02:00			`cmake --build .`
			`cmake --install . --prefix /usr`
			```

Add Arch packaging. TODO: Gentoo, Debian and Red Hat packaging. 2024-05-13 15:09:20 +02:00			`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.`

Initial commit 2024-05-05 23:31:42 +02:00			`## Usage`

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

			`## License`

Fix typo in the README. 2024-05-05 23:45:28 +02:00			`This project is licensed under the GNU Lesser General Public License v3.0 - see the [LICENSE](LICENSE) file for details.`
Initial commit 2024-05-05 23:31:42 +02:00
			`## Code of Conduct`

Minor change to the Code of Conduct section. 2024-05-06 01:23:23 +02:00			`None. Just don't blow up my house. And, don't ask me to rewrite it in Rust.`