shayla

a simple yet fast static site builder
Log | Files | Refs | Submodules | README | LICENSE | git clone https://git.ne02ptzero.me/git/shayla

commit 37aec51b0db38952f42ab0187551c3881ce18c31
parent 54ec38a8e6a2fa987e837605850f65804b06ae1f
Author: Louis Solofrizzo <lsolofrizzo@online.net>
Date:   Fri, 28 Sep 2018 10:54:57 +0200

Readme: Add a basic README to the project, typos in the code

Signed-off-by: Louis Solofrizzo <lsolofrizzo@online.net>

Diffstat:
MCMakeLists.txt | 1+
AREADME.md | 28++++++++++++++++++++++++++++
Mmain.c | 4++--
3 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt @@ -56,3 +56,4 @@ add_executable(${SDOW_NAME} main.c ./sundown/html/houdini_html_e.c ./sundown/src/stack.c ) +install(TARGETS ${SDOW_NAME} DESTINATION bin) diff --git a/README.md b/README.md @@ -0,0 +1,28 @@ +# Shayla + +Generate an HTML static site from markdown sources. + +### Clone + + git clone git://git.ne02ptzero.me/shayla --recursive + +### Compile and Install + + cd shayla/ && mkdir build && cd build && cmake .. && make && sudo make install + +### Usage + + Options: + -v, --version Print software version + -h, --help Show this message + -t, --title=TITLE Title to be used in the final site + -s, --src=DIR Markdown sources directory + -c, --style=DIR Style sources directory + -l, --layouts=DIR Layouts directory + -d, --dest=DIR Destination directory + -r, --root=ROOT Root URL of the website + -f, --favicon=FILE Favicon to use + -u, --url=URL Url of the website + -i, --img=DIR Images directory + -t, --threads=NUM Number of threads to launch + --debug Print more information diff --git a/main.c b/main.c @@ -103,8 +103,8 @@ static opts_t options[] = { static void help(void) { usage("Usage: " SDOWN_NAME " -[vhtsldrfuit]"); - usage("Generate an HTML static site for markdown sources."); - usage ("If used with no options, " SDOWN_NAME " will look for directory in the current path."); + usage("Generate an HTML static site from markdown sources."); + usage ("If used with no options, " SDOWN_NAME " will look for the directory in the current path."); usage(""); usage("Options:"); usage(" -v, --version Print software version");