From 4f575b81c3ac9a19f1c9669ee9075787581f5049 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9o=20Winterhalter?= <theo.winterhalter@gmail.com>
Date: Wed, 23 Oct 2024 16:48:31 +0200
Subject: [PATCH] Explain options in README

---
 README.md    | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 src/index.md |  1 -
 2 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f111f61..b2d4774 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,62 @@ We think it's better to have a picture, but it's your choice.
 
 The same goes for email and so on.
 
+We give the semantics of the various fields (all of whom are optional).
+
+### General
+
+- `title`: Title for your page, it will appear in the tab (metadata).
+
+- `author`: Typically your name. It will appear in the page and as metadata.
+
+- `shortbio`: Some form of subtitle where you can present yourself in a few
+  words. It will appear below your name.
+
+- `email`: Your email. It will appear next to an envelope in monospace font.
+
+- `location`: Information about your location (university, office, …).
+  It will appear next to a pin icon.
+
+- `picture`: A path (relative or absolute) to the profile picture.
+
+- `picture-round`: A boolean (`true` or `false`) deciding whether your profile
+  picture is rounded or left as a square.
+  By default, it is square.
+
+### OpenGraph
+
+OpenGraph carries information that used by social media and messaging app to
+display your links *nicely*, typically with the picture and a small
+description.
+
+- `description-meta`: Description of the page to appear in the metadata
+  and in the OpenGraph data.
+
+- `og-url`: This should be a full URL (starting with `http` or `https`) to your
+  website. This is required by the format.
+
+- `og-picture`: A full URL (starting with `http` or `https`) linking to a
+  picture to display.
+
+### Social and academic accounts
+
+- `github`: Username to your github account.
+
+- `orcid`: Your ORCID number (in the shape `0000-0000-0000-0000`).
+
+- `dblp`: *URL* to your DBLP page.
+
+- `scholar`: *URL* to your Google Scholar page.
+
+- `hal`: *URL* to your HAL page.
+
+- `mastodon`: *URL* to your Mastodon account.
+
+- `gitlab`: *URL* to your Gitlab account.
+
+- `bluesky`: *URL* to your BlueSky account.
+
+
 ## Sharing files
 
 Anything you put in the `website` directory will be available online too.
diff --git a/src/index.md b/src/index.md
index 54e91b1..103e0de 100644
--- a/src/index.md
+++ b/src/index.md
@@ -9,7 +9,6 @@ email: noreply@noemail.com
 picture: img/profile.png
 picture-round: false
 og-picture: https://basicpage.github.io/img/profile.png
-github: basicpage
 orcid: 0000-0000-0000-0000
 dblp: https://dblp.org/
 scholar: https://scholar.google.com/