sections in HTML. Slideshow functiond
+ developed and used for the website of http://yurt.in
0.1 - 19 October 2012
- Initial release following a minimalist design
- and a directory structure inspired by ruby projects.
- Called JaroWeb for lack of fantasy, first used to
- create websites as the author's, as well stuff like
+
+ Initial release following a minimalist design and a directory
+ structure inspired by ruby projects. Called JaroWeb for lack
+ of fantasy, first used to create websites as the author's
+ http://jaromil.dyne.org as well stuff like
http://pirati5stelle.it or http://democrazialiquida.eu
Earlier around 2010
+
Various scripts descend from a rewrite of some Dyne.org
websites made by Jaromil and Hellekin in Ruysdael Squat.
diff --git a/README.txt b/README.txt
index dc8308b..3046e24 100644
--- a/README.txt
+++ b/README.txt
@@ -18,19 +18,77 @@
* USE INSTRUCTIONS
- Create a directory for your website and place the webnomad
- directory inside it, from a tar.gz archive or git or your
- own copy, i.e: git clone git@code.dyne.org:webnomad.git
+ As of now, webnomad is operated from a Terminal.
+ A simple interface might be built in future if donors request it.
- Run ./webnomad/init and the skeleton of your new webpage is
- created inside the directory.
+** BASIC USAGE
- Customise files in tmpl/ and create pages in views/
+ First create a directory for your website, then place the webnomad
+ directory inside it, i.e. the one downloaded from the source archive
+ or git repo.
- Run ./webnomad/render and the webpage will be in pub/
+ From a terminal, cd inside your new website's directory and run:
- Upload your website from pub/ on any webserver.
+ ./webnomad/init
+ the skeleton of your new webpage is created inside the directory:
+
+ views/ -> contains the pages you want to edit
+ tmpl/ -> contains templates like header, footer and navbar
+
+ Now go customise files in tmpl/ with your favorite HTML editor and
+ then go as well in views/ to create your web pages, better start
+ from index.html.
+
+ To see results, run ./webnomad/render and your webpages will be in
+ pub/ with all markdown rendered, header navbar and footer
+ applied. To preview open the pub/index file with a web browser
+ (chromium is recommended, since it does not need the .html extension
+ on local files...)
+
+ Upload your website with a recursive Scp or Rsync from pub/* on any
+ webserver.
+
+** USE MARKDOWN
+
+ To avoid the tedious task of using HTML tags for everything, even
+ simple formatted text, webnomad supports interlacing markdown
+ sections within an HTML page. This is simply done opening and
+ closing the tags ... which can recur more
+ than once in the same document.
+
+ This approach simplifies the use of markdown within a bootstrap
+ styled page, where you can use the classes of bootstrap as
+ usual, directly in HTML, but then go on filling them up with our
+ beloved simplified markup - *cough* *cough* - markdown.
+
+** IMAGE SLIDESHOW
+
+ To create an image slideshow simply create a page with extension
+ .gallery inside the views/ directory, for example one can call it
+ views/vacation_in_Italy.gallery
+
+ To add images into it one should create a -files directory inside
+ views/ better if named after the gallery page, something like:
+ views/vacation_in_Italy-files/
+
+ Proceed copying your images inside the -files directory, resized to
+ the format you want them to appear in the slideshow. One can also
+ use webnomad/convert an optional script that helps to do batch
+ conversions.
+
+ Now fill in the filenames of your images inside the .gallery file,
+ one per line, relative to the views/ path. For instance our
+ views/vacation_in_Italy.gallery file can contain:
+
+ vacation_in_Italy-files/Fontana_di_Trevi.jpeg
+ vacation_in_Italy-files/Torre_di_Pisa.jpeg
+ vacation_in_Italy-files/Er_cupolone.jpeg
+ vacation_in_Italy-files/Spiaggia_con_bagnanti.jpeg
+ vacation_in_Italy-files/Io_e_te_sudati.jpeg
+
+ At last run webnomad/render and the slideshow will be ready at the
+ page in pub/ which in our case is pub/vacation_in_Italy.
* DEVELOPERS
@@ -44,25 +102,22 @@
Money donations are very welcome and well needed
- http://dyne.org/donate
-
-
+ https://www.dyne.org/donate
* LICENSE
-# Copyright (C) 2012-2013 Denis Roio
-#
-# This source code is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Public License as published by
-# the Free Software Foundation; either version 3 of the License, or
-# (at your option) any later version.
-#
-# This source code is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-# Please refer to the GNU Public License for more details.
-#
-# You should have received a copy of the GNU Public License along with
-# this source code; if not, write to:
-# Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+WebNomad is Copyright (C) 2012-2013 Denis Roio
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public
+License along with this program.
+If not, see http://www.gnu.org/licenses