summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@inventati.org>2020-03-12 02:59:04 +0530
committerAndinus <andinus@inventati.org>2020-03-12 02:59:04 +0530
commita0d936354801a0ba4c03d840ec086251d4c461ac (patch)
tree606033c1742fcb358800c3b520d7a207934d8785
parent9db33380e4baadd725190c18f35810039c1c780e (diff)
downloadcetus-a0d936354801a0ba4c03d840ec086251d4c461ac.tar.gz
Revert "Move README from org file to markdown"
This reverts commit 9db33380e4baadd725190c18f35810039c1c780e.
-rw-r--r--README.md41
-rw-r--r--README.org30
2 files changed, 30 insertions, 41 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 62dd24b..0000000
--- a/README.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# Cetus
-
-Cetus is a wallpaper setting tool written in Go. This is a work in-progress.
-
-## Dependency
-
-- [feh](https://feh.finalrewind.org/)
-
-## Features
-
-- Supports various Image of the Day services
-
-There are several Image of the Day services on the web, cetus will pull the
-latest image & set it as wallpaper.
-
-Currently it supports:
-
-- [Astronomy Picture of the Day](http://apod.nasa.gov/apod/astropix.html)
-
-## Examples
-
-### Image of the Day
-
-#### Astronomy Picture of the Day
-
-``` sh
-# Pull image from Astronomy Picture of the Day
-cetus -apod -apod-api=https://api.nasa.gov/planetary/apod \
-      -apod-api-key=DEMO_KEY
-```
-
-### Set given wallpaper
-
-``` sh
-# Local image as wallpaper
-cetus -img-path=/path/to/img
-
-# Remote image as wallpaper
-cetus -img-path=http://127.0.0.1
-
-```
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..82b21ea
--- /dev/null
+++ b/README.org
@@ -0,0 +1,30 @@
+#+TITLE: Cetus
+
+Cetus is a wallpaper setting tool written in Go. This is a work in-progress.
+
+* Dependency
+** [[https://feh.finalrewind.org/][feh]]
+Required to set the wallpaper.
+* Examples
+** Image of the Day
+*** Astronomy Picture of the Day
+#+BEGIN_SRC sh
+cetus -apod -apod-api=https://api.nasa.gov/planetary/apod \
+      -apod-api-key=DEMO_KEY
+#+END_SRC
+** Set given wallpaper
+#+BEGIN_SRC sh
+# Local image as wallpaper
+cetus -img-path=/path/to/img
+
+# Remote image as wallpaper
+cetus -img-path=http://127.0.0.1
+#+END_SRC
+
+* Features
+** Supports various Image of the Day services
+There are several Image of the Day services on the web, cetus will pull the
+latest image & set it as wallpaper.
+*** DONE [[http://apod.nasa.gov/apod/astropix.html][Astronomy Picture of the Day]]
+** DONE Set given wallpaper
+Takes a path as input & sets it as wallpaper.