-
Notifications
You must be signed in to change notification settings - Fork 235
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document how to install CommonMark on newer Macs
- Loading branch information
Showing
1 changed file
with
32 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
@@ -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 | ||
|
@@ -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: | ||
|