branch: elpa/julia-mode
commit 5c940c4ba357d8361534f11169f3d40b2d7833fc
Merge: 7fc071eb2c 3ca7155137
Author: Tamas K. Papp <tkp...@gmail.com>
Commit: GitHub <nore...@github.com>
Merge pull request #221 from tpapp/tp/readme-dustoff
Dust off the README. Fixes #216.
---
README.md | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 372b62e69a..0ba71ea702 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,6 @@
[Emacs](https://www.gnu.org/software/emacs/) major mode for [the Julia
programming language](https://julialang.org/).
-
## Installation
### Installing from MELPA
@@ -41,13 +40,29 @@ To get the latest version of `julia-mode`, clone this
repository and then use:
(require 'julia-mode)
```
+## Configuration
+
+You can customize all options in this package with `M-x customize-mode
julia-mode` using the interactive Emacs interface.
+
+Replacement of LaTeX symbols now uses the generic Emacs API. To get back the
previous mechanism, use
+
+``` elisp
+(define-key julia-mode-map (kbd "TAB") 'julia-latexsub-or-indent)
+```
+
+## Related packages
+
+- [Julia major mode using
tree-sitter](https://github.com/JuliaEditorSupport/julia-ts-mode)
+- [make using Julia’s language server easier with
eglot](https://github.com/non-Jedi/eglot-jl/)
+- [julia-repl: run an inferior Julia REPL in
Emacs](https://github.com/tpapp/julia-repl/)
+- [a development environment and REPL interaction package for Julia in the
spirit of Common Lisp’s SLIME](https://github.com/gcv/julia-snail)
+
## Contributing
Contributions are welcome, in the form of pull requests.
We do our best to provide feedback within 2 weeks. Feel free bump the PR
thread with a comment after that.
-
### Submitting Pull Requests
- Do add unit tests whenever possible. Consider breaking functions into an
interface and a backend function for convenient testing.
@@ -56,7 +71,6 @@ We do our best to provide feedback within 2 weeks. Feel free
bump the PR thread
- Do use the `rx` macro (S-expressions) whenever rewriting regular expressions
or introducing new ones. This keeps the code much more readable.
-
### Working With Tests
It's easy to add new
[ERT](https://www.gnu.org/software/emacs/manual/html_node/ert/index.html) tests
to the `julia-mode` test suite.
