From e089bf6d4b464793ff0090b0a3881aeacc773e0b Mon Sep 17 00:00:00 2001 From: m1ka Date: Mon, 27 Jul 2026 20:41:36 +0200 Subject: [PATCH] new readme --- FORMALITIES.md | 3 +++ README | 20 -------------------- README.md | 9 +++++++++ 3 files changed, 12 insertions(+), 20 deletions(-) create mode 100644 FORMALITIES.md delete mode 100644 README create mode 100644 README.md diff --git a/FORMALITIES.md b/FORMALITIES.md new file mode 100644 index 0000000000000000000000000000000000000000..16b89ea58efee48d96ffb4b193f68cb0d64bf1cc --- /dev/null +++ b/FORMALITIES.md @@ -0,0 +1,3 @@ +===== licensing ===== + +all content (anything stored in folders that arent '/statics' and '/kethel') is licensed under https://creativecommons.org/licenses/by-sa/4.0/ CC-BY-SA-4.0> (also reproduced in 'LICENSES/CC-BY-SA-4.0.txt'). The build system (stored in 'kethel') are licensed under <#https://www.gnu.org/licenses/agpl-3.0.txt AGPL-3.0-or-later> (also reproduced in 'LICENSES/AGPL-3.0-or-later'). diff --git a/README b/README deleted file mode 100644 index 59eb4a81dae6caaf4fd8ec53097d3023f4f8a119..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,20 +0,0 @@ -====== www.m1kadev.nl ====== - -===== running ===== - -==== docker ==== - -this should work out of the box: - docker build -t 'www.m1kadev.nl' . - docker run -d -p 8080:8080 'www.m1kadev.nl' - -==== from source ==== - -Make sure you have a compatible version of <#https://codeberg.org/m1ka/fxg fxg> installed (this site is usually compiled against fxg a990e6c5ab). -go into the 'kethel' directory, and use your javascript runtime of choice (for this site, usually node.js, sadly). -afterwards, build any possible dependencies for kethel using mix. -finally, using the main.exs script ran against the kethel library, you can compile the website, which will output in the 'build' folder, in the root of the repository. - -===== licensing ===== - -all content (anything stored in folders that arent 'statics' and 'kethel') is licensed under <#https://creativecommons.org/licenses/by-sa/4.0/ CC-BY-SA-4.0> (also reproduced in 'LICENSES/CC-BY-SA-4.0.txt'). The build system (stored in 'kethel') are licensed under <#https://www.gnu.org/licenses/agpl-3.0.txt AGPL-3.0-or-later> (also reproduced in 'LICENSES/AGPL-3.0-or-later'). diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..19af31e6259fd1ec26896b2a0d7541e3bea46130 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# m1kadev.nl + +[This website](https://www.m1kadev.nl/) is one of my first (actually good) websites. + + +## see also + +- [My self-hosted sourcehut instance](https://proj.m1kadev.nl/) +- [{du}punkto](https://dupunkto.org/)