From 7d3c9ec7368a5d25235e818c2c147ba7e89f6567 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gassmann?= Date: Sun, 27 Feb 2022 14:06:15 +0100 Subject: [+] Added base project --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..d6de7df --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# SWG + +Static Website Generator. + +## Requirements + +You will need to have `cmake` installed along with a C++ compiler that supports the C++17 library (Filesystem library is used). + +## Compile + +Navigate to the project root and create the build folder along with the Makefiles: + +``` +mkdir build +cd build +cmake .. +``` + +You should now be able to compile the project by simply running `make`. + +The resulting executable will be located at `build/src/swg`. +As it is a standalone executable, you could install it by simply copying it in the `/bin` folder: + +``` +sudo cp src/swg /bin/swg +``` + +## Usage + +``` +swg -g source-website +``` + +The generation of a static website is done from a folder and file structure, you can see a template [here](https://git.gassm.ch/swg/tree/res/template-website). + +## Status + +It is still under development, really far from being finished. +You can take a look at [TODO](TODO.md) to have an idea of what is planned / under development. + +## License + +Using the [maddy](https://github.com/progsource/maddy) C++ Markdown to HTML header-only parser library developed by Petra Baranski. + +This project is licensed under the GPLv3 license. For more information see [LICENSE](LICENSE) file. -- cgit v1.2.3