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

Jump to bottom

docs: Expand installation section in README #4

Merged
merged 4 commits into from
Aug 13, 2023
Merged

docs: Expand installation section in README #4

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5beb3f6
better cargo install in README
sa- Aug 12, 2023
77f04e3
incorporate suggestion
sa- Aug 13, 2023
d547de7
appease dprint
sa- Aug 13, 2023
5b48e21
Slight update
stinodego Aug 13, 2023
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
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# Polars CLI

## CLI
## Installation

**Build from source**
Until binaries are available, the only way to install the Polars CLI is by building it from source:

```bash
cargo +nightly install --locked polars-cli
```

Alternatively, clone the repository and install the latest version on the main branch:

```bash
cargo install --locked --path .
```

#### Prerequisites

1. `rustup`: which provides the `cargo` executable. You can get it from the [official website](https://rustup.rs/).
2. `rustup install nightly` - The `nightly` version of rust, since some of our dependencies use unstable features.

## Usage

```shell
$ polars
Polars CLI version 0.3.0
Expand Down