Skip to content

Commit

Permalink
Update README.md on installation instructions
Browse files Browse the repository at this point in the history
Dropped the advice to just download `index.js` and `jump.kak` files, because this will also require renaming it to `.mjs` extension, and then we'd need to introduce more error checking and it's so tedious it's not really worth it. I guess people who really want to avoid cloning the whole repo can figure out these Node intricacies on their own.
  • Loading branch information
postsolar committed Dec 1, 2023
1 parent 1c62770 commit 3cdcea7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@ You should have [node](https://github.com/nodejs/node) installed and available i

## Installation

1. Either:
- Clone the repository
- Download just the files `index.js` and `jump.kak`.
You can put them anywhere you want as long as they happen to be in the same directory and `index.js` is called `index.js`.
Just clone the repository into your `autoload/` folder.

2. Source the file `jump.kak` in your `kakrc`.
If you clone it elsewhere, you will also need to source the file `jump.kak`.
For example, you can add this command to your `kakrc`:

```kakscript
source path/to/plugin/jump.kak
```

## Usage

Expand Down
File renamed without changes.

0 comments on commit 3cdcea7

Please sign in to comment.