Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Expanding build documentation #39

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Expanding build documentation #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 17 additions & 2 deletions morphuntion/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,21 @@ The following are the dependencies to use this code.

### Building

#### Resolving ICU4C dependancy

Before building this project, you must have a distribution of ICU4C available. The path to the ICU distribution must be
set as ICU_ROOT in either options.mk or as a command line argument to cmake. The path should be the same as the
--prefix value used when ICU was configured, built and installed.

If you want to build this project faster, you can adjust the number of concurrent build jobs used when compiling.
Typical ICU installation requires:
* Downloading "Latest" released ICU4C "Source code.[zip|tar.gz]" from https://github.com/unicode-org/icu/releases.
* Following [build and installation instructions](https://unicode-org.github.io/icu/userguide/icu4c/build.html).

##### Linux specific
* ICU4C is installed to /usr/local/lib/*icu* by default.
* ICU_ROOT should point to /usr/local/lib/. Omitting /icu applies to any other installation path.

#### Build instructions

```
cd morphuntion
Expand All @@ -95,7 +105,12 @@ CC=clang CXX=clang++ cmake -DICU_ROOT=<PATH_TO_ICU> ..
make -j 8 check
```

Alternatively, you can use cmake for the building, testing etc.
```
cmake --build . -j8 -t check
```

Optionally, ICU_ROOT can be specified in the file options.mk with the following type of syntax.
```
ICU_ROOT=<PATH_TO_ICU>
```
```