Permalink
Browse files

Initial commit

  • Loading branch information...
0 parents commit 2bf06bcd12d71348ed525ce3f2f291ac40253f70 @magnars magnars committed Oct 2, 2012
Showing with 2,901 additions and 0 deletions.
  1. +62 −0 README.md
  2. +7 −0 create-docs.sh
  3. +2,544 −0 ert.el
  4. +116 −0 examples-to-docs.el
  5. +19 −0 examples-to-tests.el
  6. +12 −0 examples.el
  7. +9 −0 pre-commit.sh
  8. +53 −0 readme-template.md
  9. +7 −0 run-tests.sh
  10. +34 −0 s.el
  11. +38 −0 watch-tests.watchr
@@ -0,0 +1,62 @@
+# s.el [![Build Status](https://secure.travis-ci.org/magnars/s.el.png)](http://travis-ci.org/magnars/s.el)
+
+The long lost Emacs string manipulation library.
+
+## Warning
+
+This is so much a work in progress that you should definitely not be using it yet.
+
+## Functions
+
+* [s-trim](#s-trim-s) `(s)`
+
+## Documentation and examples
+
+### s-trim `(s)`
+
+Remove whitespace at beginning and end of string.
+
+```cl
+(s-trim "trim ") ;; => "trim"
+(s-trim " this") ;; => "this"
+(s-trim " only trims beg and end ") ;; => "only trims beg and end"
+```
+
+
+## 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
+
+Oh, and don't edit `README.md` directly, it is auto-generated.
+Change `readme-template.md` or `examples-to-docs.el` instead.
+
+## License
+
+Copyright (C) 2012 Magnar Sveen
+
+Authors: Magnar Sveen <magnars@gmail.com>
+Keywords: strings
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+if [ -z "$EMACS" ] ; then
+ EMACS="emacs"
+fi
+
+$EMACS -batch -l s.el -l examples-to-docs.el -l examples.el -f create-docs-file
Oops, something went wrong.

0 comments on commit 2bf06bc

Please sign in to comment.