From 085467614259e3196048e8d251f9d3f558b84b93 Mon Sep 17 00:00:00 2001
From: midipix <writeonce@midipix.org>
Date: Apr 04 2021 15:36:29 +0000
Subject: README.SOFORT: re-format as markdown.


---

diff --git a/README.SOFORT b/README.SOFORT
index b909819..596ed6d 100644
--- a/README.SOFORT
+++ b/README.SOFORT
@@ -1,5 +1,4 @@
-sofort: portable software project skeleton
-------------------------------------------
+# sofort: portable software project skeleton
 
 This README file aims to speed-up the initial use of sofort
 with your own project while accounting for diverse groups
@@ -9,18 +8,16 @@ On that note, and in addition to making the most out of this document,
 you might want to join the (un)usually friendly #midipix channel on
 the freenode irc network.
 
-======================================================================
 
-LEARN BY COMPARISON:
+## LEARN BY COMPARISON:
 
-# git clone git://foss21.org/sofort
-# git clone git://foss21.org/mdso
-# diff -u  sofort/config.project mdso/config.project
-# diff -ru sofort/project        mdso/project
+`$ git clone git://foss21.org/sofort`
+`$ git clone git://foss21.org/mdso`
+`$ diff -u  sofort/config.project mdso/config.project`
+`$ diff -ru sofort/project        mdso/project`
 
-======================================================================
 
-LEARN BY EXAMPLE:
+## LEARN BY EXAMPLE:
 
 * mdso: basic configuration, explicit source list
 https://git.foss21.org/cgit.cgi/mdso/
@@ -33,11 +30,10 @@ https://git.foss21.org/cgit.cgi/compilers/bfirm/
   sofort's config test framework (cfgtest.sh) and a custom config
   step (project/config/cfgdefs.sh).
 
-======================================================================
 
-LEARN BY INSTRUCTION:
+## LEARN BY INSTRUCTION:
 
-First Use-Case: using sofort with an existing project
+* First Use-Case: using sofort with an existing project
 -- keep your original repository and the build project separate;
 -- allow testing the new build system (sofort) against the old one;
 -- merge the two at the time of your choice.
@@ -47,32 +43,30 @@ First Use-Case: using sofort with an existing project
 :: bfoo (directory containing the new build project)
 :: temp (where you'll run configure, which could be bfoo or elsewhere)
 
-* copy all files and folders from the top-level sofort repository
+- copy all files and folders from the top-level sofort repository
   into bfoo; the _include_ and _src_ sub-directories are place-holders,
   and may thus be removed.
 
-* edit config.project, keeping all three components (front-end, shared,
+- edit config.project, keeping all three components (front-end, shared,
   static) disabled for the time being.
 
-* test that everything is ready:
+- test that everything is ready:
   cd temp && /path/to/bfoo/configure --source-dir=/path/to/foo && make
 
-* the default location for public (api) headers is include/foo/
+- the default location for public (api) headers is include/foo/
 
-* edit project/common.mk and project/headers.mk. Whether you use
+- edit project/common.mk and project/headers.mk. Whether you use
   wildcards or explicit references to source files and headers is
   entirely up to you, and bears no effect on the build process.
 
-* edit config.project again, and enable the relevant component(s), that
+- edit config.project again, and enable the relevant component(s), that
   is, any or all of front-end, shared, and static); note also that you
   may remove whichever portion of config.project that is irrelevant to
   your project.
 
-* test again.
+- test again.
 
-Second Use-Case: using sofort with a new project
+* Second Use-Case: using sofort with a new project
 -- keeping everything under a single repository;
 -- no need to pass --source-dir=/path/to/foo to configure;
 -- otherwise identical to the first use-case, as outlined above.
-
-======================================================================