Skip to content

Commit

Permalink
[readme] Minor tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
dan-zheng committed Feb 23, 2024
1 parent 0508e2c commit acafb83
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
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

0 comments on commit acafb83

Please sign in to comment.