[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] elpa-admin 3f66070 019/357: Turn README back into text. Add speci
From: |
Stefan Monnier |
Subject: |
[elpa] elpa-admin 3f66070 019/357: Turn README back into text. Add special redcloth version. |
Date: |
Thu, 10 Dec 2020 18:06:06 -0500 (EST) |
branch: elpa-admin
commit 3f66070265869b86025b91d16a4a17e15d5bfde0
Author: rocky <rocky@gnu.org>
Commit: rocky <rocky@gnu.org>
Turn README back into text. Add special redcloth version.
---
README | 54 ++++++++++++++++++++++++------------------------------
1 file changed, 24 insertions(+), 30 deletions(-)
diff --git a/README b/README
index fb75923..c7229be 100644
--- a/README
+++ b/README
@@ -1,53 +1,47 @@
-h2. Emacs relative-file _load_, _require_ *==__FILE__==* and a _provide-me_
macro.
+Emacs relative-file load, require __FILE__ and a provide-me macro.
-Here we add functions: *load-relative*, *require-relative*,
-*require-relative-list*, *==__FILE__==*, and macro *provide-me*.
+Here we add functions: load-relative, require-relative,
+require-relative-list, __FILE__, and macro provide-me.
-The latest version is at
"http://github.com/rocky/emacs-load-relative/"://github.com/rocky/emacs-load-relative/
+The latest version is at http://github.com/rocky/emacs-load-relative/
-h3. *==__FILE__==*
-
-*==__FILE__==* returns the file name that that the calling program is
-running. If you are _eval_'ing a buffer then the file name of that
+__FILE__ returns the file name that that the calling program is
+running. If you are _eval_’ing a buffer then the file name of that
buffer is used. The name was selected to be analogous to the name its use in C
or Ruby.
-h3. _load-relative_
-
-_load-relative_ loads an Emacs Lisp file relative to another (presumably
currently running) Emacs Lisp file. For example if you have files _foo.el_ and
_bar.el_ in the same directory, then to load Emacs Lisp file _bar.el_ from
inside Emacs lisp file _foo.el_:
+load-relative loads an Emacs Lisp file relative to another (presumably
currently running) Emacs Lisp file. For example if you have files foo.el and
bar.el in the same directory, then to load Emacs Lisp file bar.el from inside
Emacs lisp file foo.el:
-bc. (require 'load-relative)
+ (require 'load-relative)
(load-relative "baz")
-That _load-relative_ line could above have also been written as:
+That load-relative line could above have also been written as:
-bc. (load-relative "./baz")
+ (load-relative "./baz")
or:
-bc. (load-relative "baz.el") # if you want to exclude any byte-compiled files
-
-h3. require-relative, require-relative-list
+ (load-relative "baz.el") # if you want to exclude any byte-compiled files
-If instead of loading file _baz_, you want to _require_ it:
+require-relative, require-relative-list
-bc. (require-relative "baz")
+If instead of loading file baz, you want to require it:
-or
+ (require-relative "baz")
-bc. (require-relative "./baz")
+or
-The above not only does a _require_ on _'baz_, but makes sure you get
-that from the same file as you would have if you had issued _load_relative_.
+ (require-relative "./baz")
-If you have a list of files you want to _require_, you can require
-them one shot using _require-relative-list_ like this:
+The above not only does a require on ’baz, but makes sure you get
+that from the same file as you would have if you had issued load_relative.
-bc. (require-relative-list '("dbgr-init" "dbgr-fringe"))
+If you have a list of files you want to require, you can require
+them one shot using require-relative-list like this:
-h3. provide-me
+ (require-relative-list '("dbgr-init" "dbgr-fringe"))
-Finally, macro _provide-me_ saves you the trouble of adding a symbol
-after _provide_, by using the file basename (without directory or file
+Finally, macro provide-me saves you the trouble of adding a symbol
+after provide, by using the file basename (without directory or file
extension) as the name of the thing you want to provide. Using this
-forces the _provide_ names to be the same as the filename, but I
+forces the provide names to be the same as the filename, but I
consider that a good thing.
- [elpa] elpa-admin 14ac0ef 040/357: Merge branch 'action', (continued)
- [elpa] elpa-admin 14ac0ef 040/357: Merge branch 'action', Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 18bfa15 069/357: Add coffee-mode., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 06a86aa 043/357: Add an explicit OPERATION-MODE "nil" in README's examples, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 45792fe 051/357: Remove version numbers from filenames in packages/ dir., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 35ba6e2 055/357: Update README to describe the new repository layout., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 99b8d94 054/357: admin/archive-contents.el (batch-make-archive, archive--process-simple-package): Use write-region, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 782beee 061/357: Merge branch 'action-autoselect', Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 4eaf276 078/357: * admin/archive-contents.el (batch-make-archive): Don't demote errors., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 26ce878 006/357: # Updated for SourceForge, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 938c532 010/357: add README file., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 3f66070 019/357: Turn README back into text. Add special redcloth version.,
Stefan Monnier <=
- [elpa] elpa-admin 6de6395 017/357: See if changing the name from README to README.markup gives github a clue, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 1329950 024/357: Administrivia. Add COPYING, update README and .gitignore, bump version number., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 03e28d1 028/357: README: Document usage of this repository in detail., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 5bbab91 030/357: * packages/all-1.0.el: Change version. Address byte-compiler warnings., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin ab46aeb 014/357: Relative loads for Emacs Lisp files. Adds functions __FILE__ and, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin d656221 020/357: Track original positions in the face of possible edits. Intended use in debugging where one might edit the file but continue editing., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 015e981 004/357: # Added comment about loading supplied classes separately., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 5bb5972 016/357: load-relative.el: Add provide-me and make GPL v3., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 8b07a20 027/357: * README: Explain how to run the repo build script., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 07ef2ff 033/357: Add README file, Stefan Monnier, 2020/12/10