From f8bdb18fd92ee60370893cc670fa5094062dbcbd Mon Sep 17 00:00:00 2001 From: Matias Linares Date: Wed, 24 Feb 2016 04:14:46 -0300 Subject: Add options for the output directory. This commit changes the command line changing the -d flag to -o, and the input directory is passed on $ARGV[1]. Also update readme :) --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index aaded25..87492f9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # SSG -Static site generator written in perl. +Minimal **S**tatic **S**ite **G**enerator written in perl. This software was +inspired in [sw](https://github.com/jroimartin/sw), a suckless webframework. + +## Installation + +There's no installation method for now. The *ssh* and *styles.css* should be on the same +directory, and the result directory will be there as well. + +## Usage + +ssg [switches] input-directory + +where switches can be: + +* -v print version and exits +* -h print this help and exits +* -o set the input directory (by default site.static/) + +By default the output directory is *./site.static/* (on the same directory as +this program + +## Generation + upload + +You can automate all the process creating the following script. + + ./ssg -o mysite input-dir + rsync -avz mysite/ your.site:/path/to/www + +## Author + +Matias Linares -- cgit v1.2.3-70-g09d2