Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README-mac.md #963

Merged
merged 1 commit into from
Dec 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 boost@1.60
brew link --force boost@1.60
```

## 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
Loading