emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/subed 1f7e32e176 06/22: README.org: document branches, me


From: ELPA Syncer
Subject: [nongnu] elpa/subed 1f7e32e176 06/22: README.org: document branches, mention autoloads
Date: Tue, 1 Feb 2022 14:05:40 -0500 (EST)

branch: elpa/subed
commit 1f7e32e176ed60018865e444257d5b149bb86bb6
Author: Sacha Chua <sacha@sachachua.com>
Commit: Sacha Chua <sacha@sachachua.com>

    README.org: document branches, mention autoloads
---
 README.org               |  32 +++++++++++---
 subed/subed-autoloads.el | 107 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 133 insertions(+), 6 deletions(-)

diff --git a/README.org b/README.org
index 318d1dc5b7..0035ad4c93 100644
--- a/README.org
+++ b/README.org
@@ -77,7 +77,7 @@ SubRip ( ~.srt~), WebVTT ( ~.vtt~ ), and Advanced SubStation 
Alpha ( ~.ass~, exp
      key is pressed).
 
 ** Installation
-
+*** Installing the subed package from NonGNU Elpa
 ~subed~ is now on [[https://elpa.nongnu.org/nongnu/subed.html][NonGNU ELPA]].  
On Emacs 28 and later, you can install it with ~M-x package-install~ ~subed~.
 
 To install it on Emacs 27 or earlier, add the following to your Emacs 
configuration file:
@@ -87,18 +87,36 @@ To install it on Emacs 27 or earlier, add the following to 
your Emacs configurat
 #+end_src
 
 Use ~M-x eval-buffer~ to run the code, and then use ~M-x package-install~ 
~subed~.
+*** Manual installation
 
-If that doesn't work, you can install it manually.  For example, copy 
~subed/*.el~ to
+If that doesn't work, you can install it manually. To install from the main 
branch:
 
-~$HOME/.emacs.d/elisp/~ and add ~$HOME/.emacs.d/elisp/~ to your ~load-path~.
+#+begin_src sh :eval no
+git clone https://github.com/sachac/subed.git
+#+end_src
 
-Here's some sample code for manual installation:
+This will create a =subed= directory with the code.  Then you can add
+the following to your Emacs configuration (typically
+=~/.config/emacs-init.el=, =~/.emacs.d/init.el=, or =~/.emacs=; you
+can create this file if it doesn't exist yet):
 
 #+begin_src emacs-lisp
-(add-to-list 'load-path "~/.emacs.d/elisp")
-(require 'subed)
+;; Note the reference to the subed subdirectory
+(add-to-list 'load-path "/path/to/subed/subed")
+(require 'subed-autoloads)
+#+end_src
+
+and reload your configuration with =M-x eval-buffer= or restart Emacs.
+
+If you want to try a branch (ex: =derived-mode=), you can use the
+following command inside the =subed= directory:
+
+#+begin_src sh :eval no
+git checkout branchname
 #+end_src
 
+*** use-package configuration
+
 Here's an example setup if you use use-package:
 
 #+BEGIN_SRC emacs-lisp
@@ -115,6 +133,8 @@ Here's an example setup if you use use-package:
   (add-hook 'subed-mode-hook (lambda () (setq-local fill-column 40))))
 #+END_SRC
 
+** Getting started
+
 ~C-h f subed-mode~ should get you started. This is the parent mode for
 ~subed-srt-mode~, ~subed-vtt-mode~, and ~subed-ass-mode~. When
 manually loading a mode, use those specific format modes instead of
diff --git a/subed/subed-autoloads.el b/subed/subed-autoloads.el
new file mode 100644
index 0000000000..de47cade7e
--- /dev/null
+++ b/subed/subed-autoloads.el
@@ -0,0 +1,107 @@
+;;; subed-autoloads.el --- automatically extracted autoloads  -*- 
lexical-binding: t -*-
+;;
+;;; Code:
+
+
+;;;### (autoloads nil "subed" "subed.el" (0 0 0 0))
+;;; Generated autoloads from subed.el
+
+(autoload 'subed-mode "subed" "\
+Major mode for editing subtitles.
+
+subed uses the following terminology when it comes to changes in
+subtitles' timestamps:
+
+Adjust - Increase or decrease start or stop time of a subtitle
+  Move - Increase or decrease start and stop time of a subtitle
+         by the same amount
+ Shift - Increase or decrease start and stop time of the current
+         and all following subtitles by the same amount
+
+Key bindings:
+\\{subed-mode-map}
+
+\(fn)" t nil)
+
+(register-definition-prefixes "subed" '("subed-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-ass" "subed-ass.el" (0 0 0 0))
+;;; Generated autoloads from subed-ass.el
+
+(autoload 'subed-ass-mode "subed-ass" "\
+Major mode for editing Advanced SubStation Alpha subtitle files.
+
+\(fn)" t nil)
+
+(add-to-list 'auto-mode-alist '("\\.ass\\'" . subed-ass-mode))
+
+(register-definition-prefixes "subed-ass" '("subed-ass-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-common" "subed-common.el" (0 0 0 0))
+;;; Generated autoloads from subed-common.el
+
+(register-definition-prefixes "subed-common" '("subed-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-config" "subed-config.el" (0 0 0 0))
+;;; Generated autoloads from subed-config.el
+
+(register-definition-prefixes "subed-config" '("subed-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-debug" "subed-debug.el" (0 0 0 0))
+;;; Generated autoloads from subed-debug.el
+
+(register-definition-prefixes "subed-debug" '("subed-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-mpv" "subed-mpv.el" (0 0 0 0))
+;;; Generated autoloads from subed-mpv.el
+
+(register-definition-prefixes "subed-mpv" '("subed-mpv-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-srt" "subed-srt.el" (0 0 0 0))
+;;; Generated autoloads from subed-srt.el
+
+(autoload 'subed-srt-mode "subed-srt" "\
+Major mode for editing SubRip subtitle files.
+
+\(fn)" t nil)
+
+(add-to-list 'auto-mode-alist '("\\.srt\\'" . subed-srt-mode))
+
+(register-definition-prefixes "subed-srt" '("subed-srt-"))
+
+;;;***
+
+;;;### (autoloads nil "subed-vtt" "subed-vtt.el" (0 0 0 0))
+;;; Generated autoloads from subed-vtt.el
+
+(autoload 'subed-vtt-mode "subed-vtt" "\
+Major mode for editing WebVTT subtitle files.
+
+\(fn)" t nil)
+
+(add-to-list 'auto-mode-alist '("\\.vtt\\'" . subed-vtt-mode))
+
+(register-definition-prefixes "subed-vtt" '("subed-vtt-"))
+
+;;;***
+
+(provide 'subed-autoloads)
+;; Local Variables:
+;; version-control: never
+;; no-byte-compile: t
+;; no-update-autoloads: t
+;; coding: utf-8
+;; End:
+;;; subed-autoloads.el ends here



reply via email to

[Prev in Thread] Current Thread [Next in Thread]