Updates to README.md#37
Conversation
…sity for maturin develop
ausbin
left a comment
ausbin
left a comment
There was a problem hiding this comment.
Thanks for making these changes.
Would you making some formatting tweaks?
Also, based on my limited experience with macOS, there are some steps that I don't remember needing to do. Could you confirm? It's worth the effort to keep the dev setup steps as short as we can.
| ``` | ||
| $ 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. | ||
| ``` |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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" |
There was a problem hiding this comment.
This shouldn't be needed given step 1, right?
|
|
||
| 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 |
There was a problem hiding this comment.
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.
2 participants
Updated the readme.md to include Homebrew installation options for packages.
Added a note to the maturin develop command listing -vvv as being for extended troubleshooting purposes as -vv or -v would likely be sufficient for most errors.