[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.
- [nongnu] elpa/typescript-mode 20af0fec5f 077/222: Extend function prefix font-lock test to check arguments are correct., (continued)
- [nongnu] elpa/typescript-mode 20af0fec5f 077/222: Extend function prefix font-lock test to check arguments are correct., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 5e2165d4b6 038/222: We need a Gitignore-file., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 330c887241 095/222: Fix indentation of functions with numbers in return type., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode b7074c5dea 106/222: Remove redundant code, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode bf9a4155cc 043/222: Revise Emacs versions tested a little more., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode a3c91282bc 039/222: Add test-case and indentation-reference document., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode d29f31c791 045/222: Fix indentation of methods that are generators., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode e780858a86 050/222: Don't interpret spread syntax as a continuation., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode f3140123d6 067/222: Remove a leftover comment., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode aae70b59e6 023/222: Merge pull request #16 from wingyplus/add-as-and-from-keywords, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 3766e37f24 026/222: Add README,
ELPA Syncer <=
- [nongnu] elpa/typescript-mode f6907e8ae3 031/222: Fix error in compilation-mode alist registration., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 316b018d27 040/222: Add CI-config and test-runner., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode ab6d105807 076/222: Add regression tests for function name highlighting., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 2c43dd034c 068/222: Merge pull request #46 from ananthakumaran/fix/union-type-in-return-annotation, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 3361adad67 093/222: Prevent messing up comment fontification when filling paragraphs., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 5350c45aec 104/222: Add function to convert plain strings to template strings., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 7a5c74d88e 109/222: Merge pull request #72 from Wilfred/remove_cpp, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode c2d72b7d81 116/222: Fix unwanted indentation after non-keyword "each", ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 0d32c85bfb 110/222: Drop typescript-parent-mode., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 5b6d60a2b2 118/222: Fix indentation after keyword-lookalike methods., ELPA Syncer, 2022/02/06