From 5eb59e01338f7fce3b0b0b7cc9467365d335e99b Mon Sep 17 00:00:00 2001 From: Stephane Letz Date: Sat, 15 May 2021 18:26:33 +0200 Subject: [PATCH] Complete README with WARNING section. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ce3fc7c4..fd590aca 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,8 @@ The docs folder at rool level contains all files that will be published. To make - add all the new files using `git add docs` - commit using `git commit -am "message"` (so new files and deleted files will be commited, except docs/CNAME file) - and push the commit + +### WARNING!! + +- never delete the **docs/CNAME file** (which is mandatory for the final generated site to work) +- in case it has been removed, restore it using `git checkout docs/CNAME`