From ba66ae25a5789ceeae18178400a4479e180bec91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stig-=C3=98rjan=20Smelror?= Date: Fri, 2 Feb 2024 13:45:43 +0100 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bf1c7e0..2758a31 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,26 @@ # Quick Site Generator 2 Quick Site Generator 2 is a static website generator inspired by Nikola and written using Zsh. -```qsgen2``` is capable of creating static HTML pages using the native ```_html``` engine (that I'll describe in detail later) or by writing your pages and blogs in Markdown. It uses [Pandoc](https://github.com/jgm/pandoc/releases), mostly because it's the most compete tool for the job. Not all Linux distributions have it, so you can just download the binaries and place them where it suits you the best. +```qsgen2``` is capable of creating static HTML pages using the native ```_html``` engine that uses ```QStags``` (that I'll describe in detail later) or by writing your pages and blogs in Markdown. It uses [Pandoc](https://github.com/jgm/pandoc/releases), mostly because it's the most compete tool for the job. Not all Linux distributions have it, so you can just download the binaries and place them where it suits you the best. You cannot mix native and Markdown when creating your project. ## Configuration +Copy ```qsgen2``` and the directory ```include``` to ${HOME}/bin/. + +Then create you project directory, for example ```${HOME}/sites/new-site```. +Copy the file ```config``` and the directory ```themes``` to your project directory. + You first have to configure your site and this is done in the file [config](config). +Do the necessary changes. + +Create a directory named ```blog``` if you want to have blogs on your site. + +Create your index file with either ```tpl``` to use the native engine or ```md``` to use Markdown. +I will, as mentioned, create a how-to on ```QStags```. + +I am considering adding a command line, ```init```, that will guide you through this process in an interactive manner. ## Themes