diff --git a/readme.org b/readme.org index d0518bd..787882d 100644 --- a/readme.org +++ b/readme.org @@ -4,7 +4,15 @@ [[https://stable.melpa.org/#/parinfer-rust-mode][file:https://stable.melpa.org/packages/parinfer-rust-mode-badge.svg]] * Parinfer - [[https://shaunlebron.github.io/parinfer/][Parinfer]] is a plugin that aims to make writing lisp simple. This library is a minimalistic wrapper around [[https://github.com/eraserhd/parinfer-rust][eraserhd/parinfer-rust]] to provide an Emacs minor mode. parinfer-rust-mode aims to be a simpler adaptation of Parinfer that only offers "smart mode", leveraging the parinfer-rust plugin to do most of the heavy lifting. +[[https://shaunlebron.github.io/parinfer/][Parinfer]] is a plugin that aims to make writing lisp simple. This library is a minimalistic wrapper around [[https://github.com/justinbarclay/parinfer-rust][justinbarclay/parinfer-rust-emacs]], an Emacs-centric fork of [[https://github.com/eraserhd/parinfer-rust][eraserhd/parinfer-rust]], to provide an Emacs minor mode. parinfer-rust-mode aims to be a simple implementation of Parinfer that leverages the parinfer-rust plugin to do most of the heavy lifting. + +#+begin_quote +[!WARNING] +Version 0.9 and greater of ==parinfer-rust-mode== only supports my fork of ==parinfer-rust==, ==parinfer-rust-emacs==. You can read about my reasons [[https://github.com/justinbarclay/parinfer-rust/discussions/9][here]]. + +For those of you wanting to continue using ==parinfer-rust==, you should pin your install to version 0.8.5. +#+end_quote + ** Capabilities: - Making code auto-adhere to formatting conventions - Influencing expression-nesting with indentation @@ -56,12 +64,12 @@ If you are using the `use-package` snippet from above, that would look like: (setq parinfer-rust-auto-download t)) #+END_SRC -[1] parinfer-rust-mode only supports auto-installing for Windows, Linux, and Arm MacOS. If you are running an intel mac you will need to compile yourself with as outlined in Option 2. +[1] parinfer-rust-mode only supports auto-installing for Windows, Linux, and Arm MacOS. If you are running an Intel Mac, you must compile it yourself, as outlined in Option 2. **** Option 2: Building library from sources -For the more adventurous of you, you can also download the ~parinfer-rust~ library from source and compile it. -***** Step 1: Build the Parinfer Rust library - When compiling manually the library name differs from platform to platform. Additionally, Emacs expects that these libraries have specific file extensions when first loading them up. This is a problem for MacOS because Rust compiles it as ~.dylib~ and we'll need to give the file an ~.so~ extension when we copy it to it's final location. +For the more adventurous, you can also download and compile the ~parinfer-rust~ library from source. +***** Step 1: Build the Parinfer Rust Emacs library + When manually compiling the library, the file name differs from platform to platform. Additionally, Emacs expects that these libraries have specific file extensions when first loading them up. This is a problem for MacOS because Rust compiles it as ~.dylib~, and we'll need to give the file an ~.so~ extension when we copy it to its final location. | Platform | File name | Required extension | |----------+------------------------+--------------------| @@ -70,9 +78,9 @@ For the more adventurous of you, you can also download the ~parinfer-rust~ libra | Windows | parinfer_rust.dll | .dll | #+BEGIN_SRC shell - git clone https://github.com/eraserhd/parinfer-rust.git + git clone https://github.com/justinbarclay/parinfer-rust-emacs.git cd parinfer-rust - cargo build --release --features emacs + cargo build --release cp ./target/release/${library-name} ~/.emacs.d/parinfer-rust/${lib-name} #+END_SRC ***** Step 2: Configure parinfer-rust-mode