emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/dash e7d5c01 043/426: Add note about README being autog


From: Phillip Lord
Subject: [elpa] externals/dash e7d5c01 043/426: Add note about README being autogenerated to Development notes.
Date: Tue, 04 Aug 2015 19:36:35 +0000

branch: externals/dash
commit e7d5c010b40b77d132ce6015095558541a7be344
Author: Magnar Sveen <address@hidden>
Commit: Magnar Sveen <address@hidden>

    Add note about README being autogenerated to Development notes.
---
 README.md         |    4 ++++
 readme-postfix.md |    4 ++++
 2 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
index e037237..7baf0aa 100644
--- a/README.md
+++ b/README.md
@@ -212,6 +212,10 @@ the tests are always running and the docs are always in 
sync:
 
     cp pre-commit.sh .git/hooks/pre-commit
 
+Oh, and don't edit `README.md` directly, it is generated.
+Change `readme-prefix.md` and `readme-postfix.md` instead,
+or if need be, the `examples-to-docs.el` logic.
+
 ## License
 
 Copyright (C) 2012 Magnar Sveen, Joel McCracken
diff --git a/readme-postfix.md b/readme-postfix.md
index d0e6247..c3a9786 100644
--- a/readme-postfix.md
+++ b/readme-postfix.md
@@ -13,6 +13,10 @@ the tests are always running and the docs are always in sync:
 
     cp pre-commit.sh .git/hooks/pre-commit
 
+Oh, and don't edit `README.md` directly, it is generated.
+Change `readme-prefix.md` and `readme-postfix.md` instead,
+or if need be, the `examples-to-docs.el` logic.
+
 ## License
 
 Copyright (C) 2012 Magnar Sveen, Joel McCracken



reply via email to

[Prev in Thread] Current Thread [Next in Thread]