Skip to content

Commit

Permalink
Update installation instructions in README ahead of first release
Browse files Browse the repository at this point in the history
  • Loading branch information
rnwst committed Jan 11, 2023
1 parent 0a62f3d commit a50bca0
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,11 @@ All known current limitations are listed below:

## Installation

pandoc-svg requires [Node.js](https://nodejs.org/en/).
``` console
git clone https://github.com/rnwst/pandoc-svg.git
cd pandoc-svg
npm link
npm install pandoc-svg --global
```
I don't like to install npm packages system-wide, since this requires superuser privileges. To install the package user-wide instead, configure npm (before running `npm link`) to use the directory `~/.local/` for global installation of npm packages (this adds the line `prefix=~/.local/` to your `~/.npmrc`):
I don't like to install npm packages system-wide, since this requires superuser privileges. To install the package user-wide instead, configure npm (before running the installation command) to use the directory `~/.local/` for global installation of npm packages (this adds the line `prefix=~/.local/` to your `~/.npmrc`):
``` console
npm config set prefix '~/.local/'
```
Expand Down

0 comments on commit a50bca0

Please sign in to comment.