From d294f2f716fff4ba72054f23f5b2d2f63edbdcfc Mon Sep 17 00:00:00 2001
From: Aminda Suomalainen <suomalainen+git@mikaela.info>
Date: Thu, 6 Apr 2023 18:34:30 +0300
Subject: [PATCH] README.markdown: rewrite

- I don't feel comfortable advertising prettier with how wide prettierignore I have
- Resolves: #289
---
 README.markdown | 62 +++++++++++++++++++++++++++----------------------
 1 file changed, 34 insertions(+), 28 deletions(-)

diff --git a/README.markdown b/README.markdown
index 2596c0f..69399cd 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,42 +1,48 @@
-My website
+# aminda.eu
 
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Mikaela/mikaela.github.io/master.svg)](https://results.pre-commit.ci/latest/github/Mikaela/mikaela.github.io/master) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Mikaela/mikaela.github.io/master.svg)](https://results.pre-commit.ci/latest/github/Mikaela/mikaela.github.io/master)
 
-Directories:
+This website should be fairly typical Jekyll project. The index contains
+`rel=me` links everywhere so projects such as Mastodon give me the green
+checkmark.
 
-- PGP/ — my PGP key(s)
-- \_\*/ — Jekyll's own files
-- blog/ — blog index & feeds
-- css/ — css
-- pages/ — normal pages
-- php/ — php scripts that haven't found their way anywhere else
-- n/ — notes to self with rememberable URLs, see {r,or,ir}/
-- r/ — redirects, some kind of personal URL shortener
-- or/ — same, but not redirecting and for Tor Onion Services
-- ir/ — same, but for I2P eepsites
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-Sitemaps:
+- [Sitemaps](#sitemaps)
+- [Unusual directories](#unusual-directories)
+  - [Submodules](#submodules)
+- [Building](#building)
 
-- sitemap.xml — automatically generated by Jekyll when building
-- sitemaps.xml — manually written sitemap index pointing to sitemaps on my
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Sitemaps
+
+- `sitemap.xml` — automatically generated by Jekyll when building
+- `sitemaps.xml` — manually written sitemap index pointing to sitemaps on my
   sites. I am not sure how it works when there are multiple domains, so
   I am keeping all sitemaps in robots.txt and sitemaps.xml on bottom
   of it. Same will possibly happen with other domains.
 
-IPFS:
+## Unusual directories
 
-I am using [IPFS](https://ipfs.io/) for some embeds on this site. If you
-would like to help me host them:
+Or directories that generally aren't encountered in other similar projects.
 
-```
-ipfs pin add bafybeia7yeie5a6arstytabl6bfhacmidcy4yhht3e6dfrrq4gi2gry4pu bafybeihqkgkjo7zywuk3wiwv7ng2iiwr4na2jpmbff5zawld33tssqe4ru bafybeiawyibtmpxvgzv7ge3vlase5rjrxnea4rqr2ndeso2bs6wibe4pue bafybeibtebp2pve6x5ajv3h7leuhsz4s4alholyahi74vr7mlpob3ajqji
-```
+- `n/` - quick notes for my personal reference with memorable addresses.
+- `r/` - my personal url redirector for links that I have to refer to more or less often.
+- `txt/` - signed text files such as account list to decrease impact of identity theft attempts.
+- `PGP/` - my current and some previous PGP keys.
 
-These hashes are:
+### Submodules
 
-- foxyproxy.json
-- avatar/favicon
+- `ir/` - list of I2P services, previously a part of this repository for memorable addresses.
+- `lfs-media/` - orphan branch containing lfs-media such as the avatars. However it doesn't work with GitHub pages.
+- `or/` - same as `ir/`, but for Tor Onion Services.
 
-There is also ipfs-files/IPFS.csv in this directory listing all the current
-content IDs and ipfs-files/IPFS-archive.csv listing the previously used CIDs
-and where they were used in.
+## Building
+
+1. Install `bundler` onto your system.
+1. `cd` to root of this repository, if you didn't already.
+1. _Optionally_ configure where you wish bundler to install everything. This repository already specifies `bundle config set --local path 'vendor/bundle'` in the gitignored `.bundle/config` file.
+1. Run `bundle install`
+1. You are done, `bundle exec jekyll <build|serve>` and similar commands should work, just remember `bundle exec` in front of the command so the system wide installation doesn't unintentionally get used.