Skip to content

[readme] Minor tweaks. #14

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

Closed
dan-zheng wants to merge 1 commit into from
Closed

[readme] Minor tweaks. #14

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
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ runtime, create a build directory and generate the build files using `cmake`
from the top-level project directory:

```sh
(cd build && cmake ..)
cmake -B build
```

Then run `make` to build the `./gemma` executable:
Expand All @@ -115,8 +115,9 @@ cd build
make -j [number of parallel threads to use] gemma
```

For example, `make -j 8 gemma`. If this is successful, you should now have a
`gemma` executable in the `build/` directory.
For example, `make -j4 gemma` will build using 4 threads. If this is successful,
you should now have a `gemma` executable in the `build/` directory. If the
`nproc` command is available, you can use `make -j$(nproc) gemma`.

> [!NOTE]
> On Windows Subsystem for Linux (WSL) users should set the number of
Expand Down Expand Up @@ -317,7 +318,7 @@ the `libgemma` target instead of `gemma`.
First, run `cmake`:

```sh
(cd build && cmake ..)
cmake -B build
```

Then, run `make` with the `libgemma` target:
Expand All @@ -327,8 +328,8 @@ cd build
make -j [number of parallel threads to use] libgemma
```

If this is successful, you should now have a
`libgemma` library file in the `build/` directory. On linux the filename is `libgemma.a`.
If this is successful, you should now have a `libgemma` library file in the
`build/` directory. On Unix platforms, the filename is `libgemma.a`.

## Acknowledgements and Contacts

Expand Down