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

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

[nongnu] elpa/typescript-mode 3766e37f24 026/222: Add README


From: ELPA Syncer
Subject: [nongnu] elpa/typescript-mode 3766e37f24 026/222: Add README
Date: Sun, 6 Feb 2022 16:59:02 -0500 (EST)

branch: elpa/typescript-mode
commit 3766e37f24d36e5f42d9b60f7568cf82a5a8ff57
Author: Jostein Kjønigsen <jostein@kjonigsen.net>
Commit: GitHub <noreply@github.com>

    Add README
---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..5497abb6ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# typescript.el
+
+`typescript.el` is major-mode for editing 
[Typescript](http://www.typescriptlang.org/)-files in [GNU 
Emacs](https://www.gnu.org/software/emacs/).
+
+`typescript.el` is a self-contained, lightweight and minimalist major-mode
+focused on providing basic font-lock/syntax-highlighting and
+indentation for Typescript syntax, without any external dependencies.
+
+# Installation
+
+`typescript.el` can be installed from source directly using your
+favourite approach or framework, or from MELPA and MELPA Stable as a
+package.
+
+To install typescript.el simply type `M-x 
install-package<RET>typescript-mode<RET>`.
+
+# Customization
+
+To customize `typescript.el` just type the following: `M-x 
customize-group<RET>typescript<RET>`.
+
+You can add any other customization you like to `typescript-mode-hook`
+in your `init.el` file. `typescript.el` also handles `prog-mode-hook`
+on versions of Emacs which supports it.
+
+
+# Other Typescript-packages of interest
+
+While `typescript.el` may *not* provide a full kitchen-sink, the good
+news is that there's other packages which do!
+
+More advanced features can be provided by using these additional
+packages:
+
+* [tide](https://github.com/ananthakumaran/tide/) - TypeScript
+  Interactive Development Environment for Emacs
+* [ts-comint](https://github.com/josteink/ts-comint) - a Typescript REPL
+  in Emacs.
+
+Initialization these with `typescript.el` will then become a matter of
+creating your own `typescript-mode-hook` in your `init.el` file.



reply via email to

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