[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/ruby-end 5e84c0c2fd 30/91: Update README.
From: |
ELPA Syncer |
Subject: |
[elpa] externals/ruby-end 5e84c0c2fd 30/91: Update README. |
Date: |
Wed, 25 Jan 2023 19:58:26 -0500 (EST) |
branch: externals/ruby-end
commit 5e84c0c2fd7fc99be2e35a8ba2bbc978f9f1aa72
Author: Johan Andersson <johan.rejeep@gmail.com>
Commit: Johan Andersson <johan.rejeep@gmail.com>
Update README.
---
README.markdown | 40 +++++++++++++++++++++++++++++++++++-----
1 file changed, 35 insertions(+), 5 deletions(-)
diff --git a/README.markdown b/README.markdown
index 20ea169153..01e4e8896c 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,7 +1,37 @@
-# ruby-end
+# Ruby end
+Ruby end is a minor mode for Emacs that can be used with `ruby-mode`
+to automatically close blocks by inserting `end` when typing a "block
+keyword", followed by a space.
-ruby-end is a minor mode for Emacs that can be used with ruby-mode to
-automatically close blocks by inserting **end** when typing a
-block-keyword, followed by a space.
+## Installation
+I recommend installing via ELPA, but manual installation is simple as well:
-See comments in **ruby-end.el** for installation and usage information.
+ (add-to-list 'load-path "/path/to/ruby-end")
+ (require 'ruby-end)
+
+## Usage
+Start `ruby-end-mode` using.
+
+ (ruby-end-mode t)
+
+or
+
+ M-x ruby-end-mode
+
+Now try writing a block keyword, such as `class` or `def` and then `SPACE`.
+
+For more information, see comments in `ruby-end.el`.
+
+## Contribution
+Contribution is much welcome! Ruby end is tested using
[Ecukes](http://ecukes.info). When
+Adding new features, please write tests for them!
+
+To fetch Ecukes:
+
+ $ cd /path/to/ruby-end
+ $ git submodule init
+ $ git submodule update
+
+Run the tests with:
+
+ $ ./util/ecukes/ecukes features
- [elpa] externals/ruby-end d96d77b932 06/91: Update description., (continued)
- [elpa] externals/ruby-end d96d77b932 06/91: Update description., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end ed15f7506b 07/91: Update mode description., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 648b81af13 77/91: Release v0.4.1, ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 627684646f 89/91: Hook into ruby-ts-mode as well, ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 91fd0a7340 08/91: Quote keywords differently., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 538c52fae3 10/91: Doc change., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 421206670d 14/91: Update to v0.0.2., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 9ac13296f0 18/91: tests for statement modifiers, ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 23c574c454 24/91: Add scenario for optional newline., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end bc018f6856 27/91: End should be inserted actually, ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 5e84c0c2fd 30/91: Update README.,
ELPA Syncer <=
- [elpa] externals/ruby-end 06c6378903 29/91: Update ecukes., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 47e5b92b8b 33/91: Autoformat using "cucumber --autoformat"., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 49354ca1a3 36/91: Add punctuation in doc., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end a7723ccdd2 38/91: These two are mixed up., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 91f3c3fc6e 40/91: Add option to expand on return., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 3b2794392a 03/91: Added necessary stuff for running Ecukes., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end 5f9a9721a5 02/91: Added skeleton., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end d00bb287d6 05/91: Adding some docs., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end d957d3313b 12/91: Split on more than one line., ELPA Syncer, 2023/01/25
- [elpa] externals/ruby-end afd0459b11 11/91: When not expanding, fall back instead of assuming that space inserts a blank., ELPA Syncer, 2023/01/25