commit 00a13505aef2305ac56e010013b731e3d026ad21
parent c1e5f12e6982805d10e9c04ffc85fa71e4ca4f8f
Author: Dimitrije Dobrota <mail@dimitrijedobrota.com>
Date: Thu, 27 Jun 2024 17:25:03 +0200
Update README.md
Diffstat:
2 files changed, 47 insertions(+), 6 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -4,7 +4,7 @@ include(cmake/prelude.cmake)
project(
hemplate
- VERSION 0.1.9
+ VERSION 0.1.10
DESCRIPTION "Simple HTML template engine"
HOMEPAGE_URL "https://git.dimitrijedobrota.com/hemplate.git"
LANGUAGES CXX
diff --git a/README.md b/README.md
@@ -1,15 +1,56 @@
# hemplate
-This is the hemplate project.
+Simple XML template engine
-# Building and installing
+## Description
+
+This project aims to provide a simple interface for painlessly producing XML
+output from C++ code. It removes the need for keeping track of opening and
+closing tags, as well as easy manipulation of tag attributes and tag nesting.
+
+The big source of inspiration for this project is GNU cgicc.
+
+
+## Dependencies
+
+* CMake 3.14 or latter
+* Compiler with C++20 support (tested: clang 16.0.5, gcc 13.2.0)
+
+
+## Building and installing
See the [BUILDING](BUILDING.md) document.
-# Contributing
+
+## Usage
+
+> Please reference demo folder for relevant usage example.
+
+
+## Help
+
+Refer to [GNU cgicc documentation](https://www.gnu.org/software/chicc/)
+
+
+## Version History
+
+- 0.1
+ * Initial development phase
+ * Getting a feel for the features and needs
+
+
+## Contributing
See the [CONTRIBUTING](CONTRIBUTING.md) document.
-# Licensing
-This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) document for details
+## Licensing
+
+This project is licensed under the MIT License -
+see the [LICENSE](LICENSE.md) document for details
+
+
+## Acknowledgments
+
+Inspiration, code snippets, etc.
+* [GNU cgicc documentation](https://www.gnu.org/software/chicc/)
