Skip to content

Commit 5c940c4

Browse files
authored
Merge pull request #221 from tpapp/tp/readme-dustoff
Dust off the README. Fixes #216.
2 parents 7fc071e + 3ca7155 commit 5c940c4

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
[Emacs](https://www.gnu.org/software/emacs/) major mode for [the Julia programming language](https://julialang.org/).
77

8-
98
## Installation
109

1110
### Installing from MELPA
@@ -41,13 +40,29 @@ To get the latest version of `julia-mode`, clone this repository and then use:
4140
(require 'julia-mode)
4241
```
4342

43+
## Configuration
44+
45+
You can customize all options in this package with `M-x customize-mode julia-mode` using the interactive Emacs interface.
46+
47+
Replacement of LaTeX symbols now uses the generic Emacs API. To get back the previous mechanism, use
48+
49+
``` elisp
50+
(define-key julia-mode-map (kbd "TAB") 'julia-latexsub-or-indent)
51+
```
52+
53+
## Related packages
54+
55+
- [Julia major mode using tree-sitter](https://github.com/JuliaEditorSupport/julia-ts-mode)
56+
- [make using Julia’s language server easier with eglot](https://github.com/non-Jedi/eglot-jl/)
57+
- [julia-repl: run an inferior Julia REPL in Emacs](https://github.com/tpapp/julia-repl/)
58+
- [a development environment and REPL interaction package for Julia in the spirit of Common Lisp’s SLIME](https://github.com/gcv/julia-snail)
59+
4460
## Contributing
4561

4662
Contributions are welcome, in the form of pull requests.
4763

4864
We do our best to provide feedback within 2 weeks. Feel free bump the PR thread with a comment after that.
4965

50-
5166
### Submitting Pull Requests
5267

5368
- 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
5671

5772
- Do use the `rx` macro (S-expressions) whenever rewriting regular expressions or introducing new ones. This keeps the code much more readable.
5873

59-
6074
### Working With Tests
6175

6276
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.

0 commit comments

Comments
 (0)