Skip to content

Commit

Permalink
doc(README-mac.md): Add instruction to install from homebrew directly (
Browse files Browse the repository at this point in the history
  • Loading branch information
tshu-w authored Dec 21, 2024
1 parent 2930c26 commit 3a8ed90
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README-mac.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Rime with Mac

## Preparation
There are two ways to install librime on macOS:

## 1. Using Homebrew (Recommended)

```sh
brew install librime
```

## 2. Manual Compilation

### Preparation

Install Xcode with command line tools.

Expand All @@ -10,15 +20,15 @@ Install other build tools:
brew install cmake git
```

## Get the code
### Get the code

``` sh
git clone --recursive https://github.com/rime/librime.git
```
or [download from GitHub](https://github.com/rime/librime), then get code for
third-party dependencies separately.

## Install Boost C++ libraries
### Install Boost C++ libraries

Boost is a third-party library which librime code heavily depend on.
These dependencies include a few header-only Boost libraries.
Expand Down Expand Up @@ -71,7 +81,7 @@ brew install [email protected]
brew link --force [email protected]
```

## Build third-party libraries
### Build third-party libraries

Required third-party libraries other than Boost are included as git submodules:

Expand All @@ -93,7 +103,7 @@ You can also build an individual library, eg. `opencc`, with:
make deps/opencc
```

## Build librime
### Build librime

``` sh
make
Expand All @@ -107,7 +117,7 @@ Or, create a debug build:
make debug
```

## Run unit tests
### Run unit tests

``` sh
make test
Expand All @@ -119,7 +129,7 @@ Or, test the debug build:
make test-debug
```

## Try it in the console
### Try it in the console

``` sh
(
Expand Down

0 comments on commit 3a8ed90

Please sign in to comment.