commit 6b3e918f4e55d1e708e3e3e594c57be895360996
parent 9d8493112e58cdd1cc8c79ffb7bc390dc48b1c28
Author: Vincent Demeester <vincent@sbr.pm>
Date: Sat, 23 May 2020 12:51:27 +0200
Makefile: add README.md target…
… this should fix the constant regeneration of the README
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
3 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/Makefile b/Makefile
@@ -79,11 +79,13 @@ clean-www:
# Documentation build and publishing
.PHONY: update-docs
-update-docs:
+update-docs: README.md
@echo "Updating docs references…"
$(EMACS) --batch --directory $(DOTEMACS)/lisp/ \
--load lib/lisp/docs.el \
--funcall update-docs
+
+README.md: README.org
@echo "Updating README.md…"
$(EMACS) --batch --directory $(DOTEMACS)/lisp/ \
--load lib/lisp/docs.el \
diff --git a/README.md b/README.md
@@ -31,7 +31,8 @@ reproducible and easily testable without making *a mess*. Nix/NixOS should help
This will be a all-time work-in-progress, so please beware that things might change
dramatically or even not working anymore 😛.
-See [`./tasks.org`](./tasks.md) for the *work-in-progress* — and there is **a lot of work-in-progress** 👼.
+See [`./tasks.org`](./tasks.md) for the *work-in-progress* — and there is **a lot of work-in-progress**
+👼.
<a id="h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c"></a>
@@ -91,7 +92,7 @@ soon-ish 👼):
Most of the `make` commands will try to populate this ahead of time. The assumption is :
have a `sync` folder where the assets are. *Note: how to bootstrap (as syncthing will
not be there, and the `sync` folder either)*
-- `docs`: holds documentation about this code, literate configuration, see [literate configuration](#org1e494b0).
+- `docs`: holds documentation about this code, literate configuration, see [literate configuration](#org54dd53e).
`make publish` will publish the `README.org` and the `docs` folder to my website.
- `lib`: shared code used during configuration (mostly `nix` code).
- `machines`: configuration per machines
@@ -101,7 +102,7 @@ soon-ish 👼):
- `private`: holds non-shareable code, like *secrets*.
- `tmp`: things to… organize (e.g. where I import my other *legacy* configuration)
-<a id="org1e494b0"></a>As I'm slowly, but <span class="underline">surely</span>, going to have `org-mode` files for
+<a id="org54dd53e"></a>As I'm slowly, but <span class="underline">surely</span>, going to have `org-mode` files for
literate configuration files in this repository, I have to think of how to organize files
in order to end up with one huge file. The goal of having those `org-mode` files, is
mainly to document my configuration and publish it, most likely on [sbr.pm](https://sbr.pm).
diff --git a/README.org b/README.org
@@ -22,7 +22,9 @@
This will be a all-time work-in-progress, so please beware that things might change
dramatically or even not working anymore 😛.
-See [[./tasks.org][=./tasks.org=]] for the /work-in-progress/ — and there is *a lot of work-in-progress* 👼.
+See [[./tasks.org][=./tasks.org=]] for the /work-in-progress/ — and there is *a lot of work-in-progress*
+👼.
+
* TODO Installation
:PROPERTIES:
:CUSTOM_ID: h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c
