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

Update README.md #15

Merged
merged 1 commit into from
Feb 23, 2024
Merged

Update README.md #15

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
21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ and continuation passing style uses of Seastar.

# Building

Install dependencies (assuming a recent verison of Ubuntu such as 22.04):
See the section below on requirements for specific environments that are known to work.

Install dependencies:

```bash
git submodule update --init --recursive
Expand All @@ -17,10 +19,25 @@ apt-get install -qq ninja-build clang
Configure and build:

```
CXX=clang++ CC=clang cmake -Bbuild -S. -GNinja
cmake -Bbuild -S. -GNinja
ninja -C build
```

Or if you need to specify a non-default compiler:

```
CC=clang CXX=clang++ cmake -Bbuild -S. -GNinja
ninja -C build
```

# Requirements

A compiler that supports at least C++17 is required. Some examples known to work:

* Ubuntu 22.04. The default GCC version of is new enough to work. This should be installed by default with the instructions above. This is also the combination that runs in our CI. See [.github/workflows/build.yml](.github/workflows/build.yml). Both clang-14 and clang-15 have issues on Ubuntu 22.04.
* Ubuntu 23.10. Both the default GCC 13.2.0 and Clang 16 are known to work out of the box.
* Fedora 38 and newer are known to work.

# Running

The sample program splits an input file into chunks. Each core reads a subset of
Expand Down
Loading