From 3b71ae4119a00c8c1351a845c54fa643764f4324 Mon Sep 17 00:00:00 2001
From: Andinus <andinus@inventati.org>
Date: Sat, 14 Mar 2020 01:08:22 +0530
Subject: Add install instructions & clean readme

---
 README.org | 38 +++++++++++++++++++++++++++++++++++---
 1 file changed, 35 insertions(+), 3 deletions(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 5808835..a369fe3 100644
--- a/README.org
+++ b/README.org
@@ -5,9 +5,12 @@ wallpapers.
 
 *Note*: Cetus is a work in-progress & many features are yet to be implemented.
 
-* Uses
-- on system startup for new wallpaper at every startup
-- as a cron job to change wallpaper at set intervals
+* Features
+- set a random/daily/weekly wallpaper
+- set a specific photo as wallpaper
+- set a wallpaper from a specific user, user's likes, a collection or a search
+  term
+- customize wallpaper size
 * Demo
 I just run some cetus commands on my computer, nothing fancy. I'll make better
 demo videos someday.
@@ -17,3 +20,32 @@ demo videos someday.
 | v0.2.0  | https://diode.zone/videos/watch/12db31e1-3517-4888-ad06-55f3859447a1 |
 * Dependency
 - [[https://feh.finalrewind.org/][feh]]
+* Installation
+** From source
+*** Download the source
+- Using Go
+#+BEGIN_SRC sh
+go get https://framagit.org/andinus/cetus.git
+#+END_SRC
+
+- Using git
+#+BEGIN_SRC sh
+git clone https://framagit.org/andinus/cetus.git
+#+END_SRC
+
+- Using curl
+#+BEGIN_SRC sh
+# get the master branch (supported formats: zip, tar.gz, tar.bz2, tar)
+curl -o cetus-master.tar.gz \
+     https://framagit.org/andinus/cetus/-/archive/master/cetus-master.tar.gz
+#+END_SRC
+*** Compile cetus
+Navigate to the source directory & compile cetus.
+
+#+BEGIN_SRC sh
+# compile
+go build
+
+# install in $PATH
+go install
+#+END_SRC
-- 
cgit 1.4.1-2-gfad0