Rename and add some documentation
authorMiguel <m.i@gmx.at>
Thu, 7 Mar 2019 19:49:16 +0000 (20:49 +0100)
committerMiguel <m.i@gmx.at>
Thu, 7 Mar 2019 19:49:16 +0000 (20:49 +0100)
Makefile [new file with mode: 0644]
README.md
estatico.cabal [new file with mode: 0644]
staticus.cabal [deleted file]

diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..2eed15c
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,2 @@
+update_gitweb_readme:
+       markdown README.md | ssh git readme miguel/estatico set
index 4d03cc1..edc803d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,41 +1,9 @@
-# estatico
+# est├ítico - static website generator
 
-This is a simple static website generator coded in Haskell.
-It uses pandoc for the heavy work, as syntax highlighting and parsing 
-of the markdown files.
+This is my minimalistic static website generator coded in **Haskell**.
+It uses **pandoc** et al. for some of the heavy work.
 
-## features
+Consult the project page for details:
 
-* No Database
-* Only Static Content
-* Sitemap derived from Directory Tree
-* Simple Markdown Files
-
-# gitweb
-
-https://github.com/miguelclean/estatico
-
-# dockerhub
-
-https://hub.docker.com/r/migueldirty/estatico/builds
-
-# example usage
-
-__NOTE: make sure DIR\_OUT exists and is a free directory__
-
-You can use the example websites inside the examples/ directory for a start.
-
-Inside the input directory (e.g. ./examples/example01/) run something along this lines:
-
-    DIR_IN=`pwd`
-    DIR_OUT=/mnt/yourwebsiteroot
-    HTML_ROOT=https://www.example.com
-    SUDO=sudo
-    IMAGE=migueldirty/estatico
-    ${SUDO} docker run --rm -v${DIR_IN}:/in:ro -v${DIR_OUT}:/out:rw ${IMAGE} /in /out ${HTML_ROOT}
-
-Or if you want to test it locally use some local DIR\_OUT and HTML\_ROOT instead:
-
-    DIR_OUT=/home/miguel/testpage
-    HTML_ROOT=/home/miguel/testpage
+* <https://www.idziorek.net/blog/Haskell/Estatico-Page-Maker/>
 
diff --git a/estatico.cabal b/estatico.cabal
new file mode 100644 (file)
index 0000000..c16e424
--- /dev/null
@@ -0,0 +1,49 @@
+cabal-version: 1.12
+
+name:           estatico
+version:        0.1.0.0
+description:    Check README.md
+author:         Michal Idziorek
+maintainer:     m.i@gmx.at
+copyright:      2019 Michal Idziorek
+license:        BSD3
+license-file:   LICENSE
+build-type:     Simple
+extra-source-files:
+    README.md
+    ChangeLog.md
+
+library
+  exposed-modules:
+      WWWStaticus
+      WWWStaticusPlugins
+  other-modules:
+      Paths_estatico
+  hs-source-dirs:
+      src
+  build-depends:
+      base >=4.7 && <5
+    , containers
+    , split
+    , directory
+    , text
+    , pandoc
+    , extra
+    , MissingH
+    , regex-compat
+    , time
+    , http-conduit
+    , bytestring
+  default-language: Haskell2010
+
+executable estatico-exe
+  main-is: Main.hs
+  other-modules:
+      Paths_estatico
+  hs-source-dirs:
+      app
+  ghc-options: -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      base >=4.7 && <5
+    , estatico
+  default-language: Haskell2010
diff --git a/staticus.cabal b/staticus.cabal
deleted file mode 100644 (file)
index 7fae162..0000000
+++ /dev/null
@@ -1,49 +0,0 @@
-cabal-version: 1.12
-
-name:           staticus
-version:        0.1.0.0
-description:    Check README.md
-author:         Michal Idziorek
-maintainer:     m.i@gmx.at
-copyright:      2019 Michal Idziorek
-license:        BSD3
-license-file:   LICENSE
-build-type:     Simple
-extra-source-files:
-    README.md
-    ChangeLog.md
-
-library
-  exposed-modules:
-      WWWStaticus
-      WWWStaticusPlugins
-  other-modules:
-      Paths_staticus
-  hs-source-dirs:
-      src
-  build-depends:
-      base >=4.7 && <5
-    , containers
-    , split
-    , directory
-    , text
-    , pandoc
-    , extra
-    , MissingH
-    , regex-compat
-    , time
-    , http-conduit
-    , bytestring
-  default-language: Haskell2010
-
-executable staticus-exe
-  main-is: Main.hs
-  other-modules:
-      Paths_staticus
-  hs-source-dirs:
-      app
-  ghc-options: -threaded -rtsopts -with-rtsopts=-N
-  build-depends:
-      base >=4.7 && <5
-    , staticus
-  default-language: Haskell2010