[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
- [elpa] externals/dash c0f2c8f 026/426: Test that it works with lexical binding., (continued)
- [elpa] externals/dash c0f2c8f 026/426: Test that it works with lexical binding., Phillip Lord, 2015/08/04
- [elpa] externals/dash 41d77ec 034/426: Add function list to readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash 06efd3c 039/426: Slight improvements to docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash 85016d3 029/426: Fix quoted forms like `' in docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash 214a7db 030/426: Quote and lowercase parameter names in docstring., Phillip Lord, 2015/08/04
- [elpa] externals/dash de5ff6a 037/426: Simplify quotes in readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash 722fea6 033/426: Include docs in README, Phillip Lord, 2015/08/04
- [elpa] externals/dash ec27b47 025/426: Turn tests into examples that can both be tested and turned into docs, Phillip Lord, 2015/08/04
- [elpa] externals/dash 4cc4147 035/426: Fix typo, Phillip Lord, 2015/08/04
- [elpa] externals/dash eea3c53 045/426: Move function list above anaphoric function description., Phillip Lord, 2015/08/04
- [elpa] externals/dash e7d5c01 043/426: Add note about README being autogenerated to Development notes.,
Phillip Lord <=
- [elpa] externals/dash 6c39876 003/426: Set up test framework with one basic test, Phillip Lord, 2015/08/04
- [elpa] externals/dash 2a9e600 046/426: Make functions paragraph into a list of links, Phillip Lord, 2015/08/04
- [elpa] externals/dash 5f6ea16 036/426: Fix typo, Phillip Lord, 2015/08/04
- [elpa] externals/dash 1b0d54f 044/426: Simplify readme generation., Phillip Lord, 2015/08/04
- [elpa] externals/dash 26113a1 041/426: Add pre-commit.sh that runs tests and updates readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash 78fc2a3 038/426: Quote and downcase params with digits in them too., Phillip Lord, 2015/08/04
- [elpa] externals/dash 32053cd 042/426: Update readme with development notes., Phillip Lord, 2015/08/04
- [elpa] externals/dash 0912aa2 048/426: Rename !uniq to !distinct, Phillip Lord, 2015/08/04
- [elpa] externals/dash 24262a1 054/426: Add file-local font-lock for defexamples and =>, Phillip Lord, 2015/08/04
- [elpa] externals/dash 9312469 053/426: !keep, Phillip Lord, 2015/08/04