Skip to content

Updates to README.md #37

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

Open
TumeloN1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updates to README.md #37

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
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,21 @@ You need to install [Rust][1] _and_ the following:
```
You should set these persistently, e.g., in your `~/.bashrc` or `~/.zshrc`.

2. The following Debian/Ubuntu packages are also needed to build:
```
2. The following packages are also needed to build:

**Debian/Ubuntu:**
```
$ sudo apt install build-essential cmake ninja-build zlib1g-dev libclang-dev
```
If you are on macOS, installing the XCode developer tools is enough and the
command above is not needed.
```
Comment on lines +74 to +76

@ausbin ausbin May 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you keep the indentation of the triple backticks how they were? See the formatting of the previous step in this list for what I mean (the export code block)

**macOS (Homebrew):**
```
$ xcode-select --install
$ brew install cmake ninja zlib llvm

@ausbin ausbin May 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not rely on the Homebrew LLVM build in my opinion, particularly when step 1 is installing LLVM.

I thought XCode shipped with CMake, ninja, and zlib. Does it not?

```
If you are on macOS, the XCode developer tools (`xcode-select --install`) are required in place of `build-essential`. You may also need to export the Homebrew LLVM path:
```
$ export PATH="$(brew --prefix llvm)/bin:$PATH"

@ausbin ausbin May 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be needed given step 1, right?

```

### Building

Expand All @@ -84,10 +93,10 @@ To generate the Python extension, run the following:
$ . venv/bin/activate
$ cd qwerty_pyrt
$ pip install maturin numpy
$ maturin develop -vvv
$ maturin develop -vv

The last command will (re)build _everything_. Passing `-vvv` to
`maturin develop` helps to give you an idea of what is going on.
The last command will (re)build _everything_. If you need additional verbosity for troubleshooting, passing `-vvv` to

@ausbin ausbin May 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for tweaking this. I try to wrap the text in this README at around 80 columns, could you do that too here? Vim can do this with gq, but I can't speak for other editors.

`maturin develop` helps to give you a better idea of what is going on.

### Testing

Expand Down