From b375e59aba6509d41a2db5bcb98ba1d6c3defe68 Mon Sep 17 00:00:00 2001
From: polpetta <polpetta@poldebra.me>
Date: Thu, 20 May 2021 11:33:17 +0000
Subject: [PATCH] Update README (#6)

Co-authored-by: Davide Polonio <poloniodavide@gmail.com>
Reviewed-on: https://git.poldebra.me/polpetta/bitdispenser.dev/pulls/6
---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 58 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4a87b54..49f1035 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,59 @@
-# bitdispenser.dev
+bitdispenser.dev
+===
 
-My personal website
\ No newline at end of file
+[![Build Status](https://ci.poldebra.me/api/badges/polpetta/bitdispenser.dev/status.svg)](https://ci.poldebra.me/polpetta/bitdispenser.dev)
+
+This is my personal website where I like to keep my thoughts mostly about
+technology & software. The site is statically generated thanks to
+[Hugo](https://gohugo.io/), and it huses the [Hermit
+theme](https://github.com/Track3/hermit). Posts are written in Markdown and then
+checked with Aspell.
+
+Note: for all the people reading this on Github, the repository is Just a
+mirror. If you want to clone from the real source, you need to head to my
+personal [Gitea instance](https://git.poldebra.me). You can clone the repository
+with:
+```sh
+git clone https://git.poldebra.me/polpetta/bitdispenser.dev.git
+```
+
+## Building the website
+
+You can have a live preview of the website locally using the following command:
+```sh
+hugo serve
+```
+
+Note that this repository uses Git LFS, so you need to enable it and pull binary
+objects first before building the site, otherwise you will likely have missing
+images & assets. If you don't have git LFS, type:
+```sh
+git lfs install
+git lfs pull
+```
+
+## Lint & spellchecker checks
+
+Lint & spellchecker are respectively done with a npm package and a bash script.
+For running them you need node installed.
+
+For lint checking:
+```sh
+npm install
+npm run lint
+```
+
+For spell check:
+```sh
+npm run spellchecker
+```
+or
+```sh
+./tools/spellchecker.sh en
+```
+
+## License
+
+Images and all the other content taken on internet are of their rispective
+owners. All the other content is to consider under CC-BY-SA 4.0. Code snippets
+otherwise specified are to be considered under MIT license.