Skip to content

Commit

Permalink
Document how to install CommonMark on newer Macs
Browse files Browse the repository at this point in the history
  • Loading branch information
oalders committed Jul 21, 2024
1 parent 57a4a8c commit e402e4e
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
- [Getting Started](#getting-started)
- [Installing Manually](#installing-manually)
- [Installing on macOS](#installing-on-macos)
- [carton](#carton)
- [cmark](#cmark)
- [Building Static Assets](#building-static-assets)
- [Running Tests](#running-tests)
- [Running the App](#running-the-app)
- [Local Git and testing considerations](#local-git-and-testing-considerations)
Expand All @@ -32,10 +35,12 @@ export PATH="$(realpath ./node_modules/.bin):$PATH"

### Installing on macOS

If you like, you can install `carton` and `cmark` via Homebrew:
#### carton

If you like, you can install `carton` via Homebrew:

```bash
brew install carton cmark
brew install carton
```

If your `carton install` is having issues with SSL-related modules, you may need
Expand All @@ -48,6 +53,31 @@ OPENSSL_PREFIX="/usr/local/Cellar/[email protected]/1.1.1q" carton install
You may need to check `/usr/local/Cellar/[email protected]` to find the latest
installed path on your system.

#### cmark

If you like, you can install the `cmark` C libraries via Homebrew:

```bash
brew install cmark
```

On an ARM mac you may need to install
[CommonMark](https://metacpan.org/pod/CommonMark) in the following way:

```bash
PERL_MM_OPT='INC=-I/opt/homebrew/Cellar/cmark/0.31.0/include LIBS="-L/opt/homebrew/Cellar/cmark/0.31.0/lib -lcmark"' cpm install -g CommonMark
```

Use `brew ls -v cmark` to find the path to your installed `cmark` files.

## Building Static Assets

```bash
npm run build
```

Without running this command you may get errors about a missing "asset map".

## Running Tests

You can use the supplied wrapper around `prove` to run tests:
Expand Down

0 comments on commit e402e4e

Please sign in to comment.