Skip to content

Commit 4511c4b

Browse files
More discussion on installation and setup
mmark installation, introduction, better npm example. Closes #420.
1 parent 2d78d14 commit 4511c4b

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

doc/SETUP.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ At a minimum, you need a POSIX environment with:
66
* `python3` with `pip` and `venv`
77
* `ruby` with `gem` and `bundler`
88

9+
Optionally, you might also want `mmark` or NodeJS and `npm`.
10+
911
When running locally, a python virtual environment is created under `lib/` and
1012
necessary tools are installed there. Similarly, ruby installations are created
1113
under `lib/`. The tools that are used can be updated with `make update-deps`.
@@ -69,36 +71,26 @@ variable with that value to disable this feature.
6971

7072
## mmark
7173

72-
If you use mmark for markdown (i.e., files starting with `%%%`), you will need
73-
to install and manage an mmark installation.
74-
75-
[`mmark`](https://github.com/mmarkdown/mmark) requires
76-
[go](https://golang.org/), and that comes with its own complications. This
77-
assumes that you have Golang setup already.
78-
79-
```sh
80-
$ go get github.com/mmarkdown/mmark
81-
$ GOBIN=~/.local/bin go install github.com/mmarkdown/mmark
82-
```
83-
84-
You might want to set aside a directory for your go code other than the default,
85-
and find a directory that is on the path where you can install `mmark`. For
86-
these, I set `GOPATH=~/gocode`.
74+
If you use `mmark` for markdown (i.e., files starting with `%%%`), you will need
75+
to install and manage an `mmark` installation.
8776

88-
Make sure to update them regularly:
89-
90-
```sh
91-
$ go get -u github.com/mmarkdown/mmark@latest
92-
$ GOBIN=~/.local/bin go install github.com/mmarkdown/mmark@latest
93-
```
77+
Binaries for [`mmark`](https://github.com/mmarkdown/mmark) is available from
78+
their [releases](https://github.com/mmarkdown/mmark/releases) and Mac users can
79+
use homebrew (`brew install mmark`).
9480

9581

9682
## npm
9783

9884
If you use dependencies such as [aasvg](https://github.com/martinthomson/aasvg),
9985
you need to have NodeJS and npm installed.
10086

101-
If npm is installed and your project has a `package.json`, then running `make`
87+
If `npm` is installed and your project has a `package.json`, then running `make`
10288
will automatically call npm to install the dependencies.
10389

104-
You can create the `package.json` by running, e.g., `npm i -save aasvg`.
90+
You can create the `package.json` by running `npm`, for example:
91+
92+
```sh
93+
$ npm i -save aasvg
94+
$ git add package.json
95+
$ git commit
96+
```

0 commit comments

Comments
 (0)