[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/dash 32053cd 042/439: Update readme with development no
From: |
Phillip Lord |
Subject: |
[elpa] externals/dash 32053cd 042/439: Update readme with development notes. |
Date: |
Tue, 04 Aug 2015 20:26:10 +0000 |
branch: externals/dash
commit 32053cda010fb70e841ecded0d8c0f6857f48277
Author: Magnar Sveen <address@hidden>
Commit: Magnar Sveen <address@hidden>
Update readme with development notes.
---
README.md | 15 +++++++++++++++
readme-postfix.md | 15 +++++++++++++++
2 files changed, 30 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
index 44f4449..e037237 100644
--- a/README.md
+++ b/README.md
@@ -197,6 +197,21 @@ or with `!compare-fn` if that's non-nil.
(!contains? '(1 2 3) 4) ;; => nil
```
+## Development
+
+Run the tests with
+
+ ./run-tests.sh
+
+Create the docs with
+
+ ./create-docs.sh
+
+I highly recommend that you install these as a pre-commit hook, so that
+the tests are always running and the docs are always in sync:
+
+ cp pre-commit.sh .git/hooks/pre-commit
+
## License
Copyright (C) 2012 Magnar Sveen, Joel McCracken
diff --git a/readme-postfix.md b/readme-postfix.md
index 2134443..d0e6247 100644
--- a/readme-postfix.md
+++ b/readme-postfix.md
@@ -1,3 +1,18 @@
+## Development
+
+Run the tests with
+
+ ./run-tests.sh
+
+Create the docs with
+
+ ./create-docs.sh
+
+I highly recommend that you install these as a pre-commit hook, so that
+the tests are always running and the docs are always in sync:
+
+ cp pre-commit.sh .git/hooks/pre-commit
+
## License
Copyright (C) 2012 Magnar Sveen, Joel McCracken
- [elpa] externals/dash ec27b47 025/439: Turn tests into examples that can both be tested and turned into docs, (continued)
- [elpa] externals/dash ec27b47 025/439: Turn tests into examples that can both be tested and turned into docs, Phillip Lord, 2015/08/04
- [elpa] externals/dash 1997e52 031/439: Treat dashes in docstring better., Phillip Lord, 2015/08/04
- [elpa] externals/dash 78fc2a3 038/439: Quote and downcase params with digits in them too., Phillip Lord, 2015/08/04
- [elpa] externals/dash 06efd3c 039/439: Slight improvements to docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash de5ff6a 037/439: Simplify quotes in readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash 5f6ea16 036/439: Fix typo, Phillip Lord, 2015/08/04
- [elpa] externals/dash 722fea6 033/439: Include docs in README, Phillip Lord, 2015/08/04
- [elpa] externals/dash 657ee8b 040/439: Slight improvements to docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash 26113a1 041/439: Add pre-commit.sh that runs tests and updates readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash e7d5c01 043/439: Add note about README being autogenerated to Development notes., Phillip Lord, 2015/08/04
- [elpa] externals/dash 32053cd 042/439: Update readme with development notes.,
Phillip Lord <=
- [elpa] externals/dash e1a362c 047/439: Update README to reflect changes in readme generation., Phillip Lord, 2015/08/04
- [elpa] externals/dash 1b0d54f 044/439: Simplify readme generation., Phillip Lord, 2015/08/04
- [elpa] externals/dash eea3c53 045/439: Move function list above anaphoric function description., Phillip Lord, 2015/08/04
- [elpa] externals/dash 2a9e600 046/439: Make functions paragraph into a list of links, Phillip Lord, 2015/08/04
- [elpa] externals/dash 8bd82c7 051/439: Show empty lists as '() instead of nil in docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash 0912aa2 048/439: Rename !uniq to !distinct, Phillip Lord, 2015/08/04
- [elpa] externals/dash 9312469 053/439: !keep, Phillip Lord, 2015/08/04
- [elpa] externals/dash 286d1d8 050/439: Show quotes around strings in examples., Phillip Lord, 2015/08/04
- [elpa] externals/dash 24262a1 054/439: Add file-local font-lock for defexamples and =>, Phillip Lord, 2015/08/04
- [elpa] externals/dash f59b480 055/439: Add !some and !every?, Phillip Lord, 2015/08/04