convert readme text file to md

2 files changed, 26 insertions, 46 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d696e4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# photoalbum
+
+photoalbum is a minimal Bash script for Unix like operating systems (such as Linux) to generate static web photo albums.
+As a requirement `convert` from ImageMagick needs to be installed.  
+
+The resulting static photo album is pure HTML+CSS (without any JavaScript!). An example album can be surfed here: https://sidewalk.ninja
+
+## Usage
+
+```
+    photoalbum clean|generate|version [rcfile] photoalbum
+    photoalbum makemake
+```
+
+* `clean`: Cleans up the workspace
+* `generate`: Generates the static photo album
+* `version`: Prints out the version
+* `makemake`: Creates a Makefile and photoalbumrc in the current working directory.
+
+## Example usage
+
+1. See if /etc/default/photoalbum fits your needs. If not, run `photoalbum makemake`, which will create a `photoalbumrc` file in the current directory.
+2. Adjust the `incoming` path in `photoalbum`. Point to a directory with all the pictures in it. 
+3. Run `make` (or `photoalbum generate`) to generate it.
+4. Distribute the `./dist` directory to a static web server.
+5. Clean the mess up with `make clean` or `photoalbum clean`
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 149dc40..0000000
--- a/README.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-NAME
-    photoalbum is a minimal bash script for linux to generate static
-    web photo albums.
-
-    Example page: https://sidewalk.ninja
-
-SYNOPSIS
-    photoalbum clean|generate|version [rcfile] photoalbum
-    photoalbum makemake
-
-    clean
-        Cleans up the working space
-
-    generate
-        Generates the static photoalbum
-
-    version
-        Prints out the version
-
-    makemake
-        Creates a Makefile and photoalbumrc in the current working
-        directory.
-
-  TUTORIAL
-    * See if /etc/default/photoalbum fits your needs. If not, copy
-    /etc/default/photoalbum to ~/.photoalbumrc in order to customize it.
-
-    * Copy all images wanted to the incoming folder (see config file)
-
-    * Run 'photoalbum generate'
-
-    * Distribute the ./dist directory
-
-    * Clean the mess up with 'photoalbum clean'
-
-    It is possible to specify a custom rcfile path too.
-
-   HTML TEMPLATES
-    Go to the templates directory and edit them as wished.
-
-LICENSE
-    See package description or project website.
-
-AUTHOR
-    Paul Buetow - <https://codeberg.org/foozone/photoalbum>
-