Skip to content

Update the readme to properly give a straight config #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update the readme to properly give a straight config #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@
The Juvix Emacs mode

## Installation

### Using straight.el

This installs juvix-mode, to your emacs config

```emacs-lisp
(use-package juvix-mode :straight (:host github :repo "anoma/juvix-mode")
:mode ("\\.\\(juvix\\)$" . juvix-mode))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

  :mode ("\\.\\(juvix\\)$" . juvix-mode))

Just to confirm. This line is necessary even though we have the following in juvix-mode.el?

(add-to-list 'auto-mode-alist '("\\.juvix\\'" . juvix-mode))
(add-to-list 'auto-mode-alist '("\\.juvix.md\\'" . juvix-mode))

If so, we'd need to add the .juvix.md extension as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, for some reason it doesn't work for me without it

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably a bug in how it's registered in the elisp

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then could you add the juvix.md extension to trigger the mode as well?

```

### Manually

To install juvix-mode, clone this repository to a path of your choice:
``` shell
git clone https://github.com/anoma/juvix-mode /path/of/choice/juvix-mode
Expand Down