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

Enhance README.md: Added Table of Contents, Grammar Improvements #421

Merged
merged 4 commits into from
Oct 30, 2023
Merged

Enhance README.md: Added Table of Contents, Grammar Improvements #421

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbc169d
Update README.md
adarsh-jha-dev Oct 28, 2023
1231fbe
Update README.md
adarsh-jha-dev Oct 28, 2023
cde4f21
Update README.md
adarsh-jha-dev Oct 28, 2023
6025372
Removed TOC from top
adarsh-jha-dev Oct 30, 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
86 changes: 45 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,58 +22,62 @@

</h1>

# pixi: Package management made easy
# pixi: Package Management Made Easy

`pixi` is a cross-platform, multi-language package manager and workflow tool
built on the shoulders of the conda ecosystem.
- [Overview](#overview)
- [Highlights](#highlights)
- [Getting Started](#getting-started)
- [Status](#status)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Built Using Pixi](#built-using-pixi)
adarsh-jha-dev marked this conversation as resolved.
Show resolved Hide resolved

`pixi` provides all developers the exceptional experience that is usually found
with package managers like `cargo` or `yarn` but for any language.
## Overview

`pixi` is made with ❤️ at [prefix.dev](https://prefix.dev)
`pixi` is a cross-platform, multi-language package manager and workflow tool built on the foundation of the conda ecosystem. It provides developers with an exceptional experience similar to popular package managers like `cargo` or `yarn`, but for any language.

![a real time pixi_demo](https://github.com/ruben-arts/pixi/assets/12893423/8b1a1273-a210-4be2-a664-32076c535428)
Developed with ❤️ at [prefix.dev](https://prefix.dev).

![Real-time pixi_demo](https://github.com/ruben-arts/pixi/assets/12893423/8b1a1273-a210-4be2-a664-32076c535428)

## Highlights

- Support for **multiple languages** like Python, C++ and R using Conda packages. Search for available packages on: [prefix.dev](https://prefix.dev)
- **All OS's**: Linux, Windows, macOS (including Apple Silicon)
- A **lockfile** is always included and always up-to-date.
- A clean and simple Cargo-like **command-line interface**.
- Install tools **per-project** or **system-wide**.
- Completely written in **Rust** and build on top of the **[rattler](https://github.com/mamba-org/rattler)** library.
- Supports **multiple languages** including Python, C++, and R using Conda packages. You can find available packages on [prefix.dev](https://prefix.dev).
- Compatible with all major operating systems: Linux, Windows, macOS (including Apple Silicon).
- Always includes an up-to-date **lockfile**.
- Provides a clean and simple Cargo-like **command-line interface**.
- Allows you to install tools **per-project** or **system-wide**.
- Entirely written in **Rust** and built on top of the **[rattler](https://github.com/mamba-org/rattler)** library.

## Getting Started

* ⚡ [Installation](#installation)
* ⚙️ [Examples](/examples)
* 📚 [Documentation](https://prefix.dev/docs/pixi/overview)
* 😍 [Contributing](#contributing)
* 🔨 [Built using Pixi](#pixibuilt)
* 🚀 [GitHub Action](https://github.com/prefix-dev/setup-pixi)
- ⚡ [Installation](#installation)
- ⚙️ [Examples](/examples)
- 📚 [Documentation](https://prefix.dev/docs/pixi/overview)
- 😍 [Contributing](#contributing)
- 🔨 [Built using Pixi](#built-using-pixi)
- 🚀 [GitHub Action](https://github.com/prefix-dev/setup-pixi)

# Status
## Status

This project is currently in _alpha stage_.
There are many features that we want to add.
The file formats are still in flux.
Expect breaking changes while we work towards a v1.0.
This project is currently in the _alpha stage_. It's actively under development, and we're planning to add many more features. The file formats are still subject to change, and you should expect breaking changes as we work towards a v1.0.

Some notable features that we have in the pipeline are:
Some notable features we have in the pipeline are:

* **Build and publish** your project as a Conda package.
* Support for **PyPi packages**.
* Support **dependencies from source**.
* Improve docs, examples and user experience
- **Build and publish** your project as a Conda package.
- Support for **PyPi packages**.
- Support for **dependencies from source**.
- Improvements to documentation, examples, and user experience.

# Installation
`pixi` can be installed on macOS, Linux, and Windows.
The provided scripts will automatically download the latest version of `pixi`, extract it, and move the `pixi` binary to `~/.pixi/bin`.
If this directory does not already exist, the script will create it.
## Installation

`pixi` can be installed on macOS, Linux, and Windows. The provided scripts will automatically download the latest version of `pixi`, extract it, and move the `pixi` binary to `~/.pixi/bin`. If this directory does not exist, the script will create it.

### macOS and Linux

## macOS and Linux
To install Pixi on macOS and Linux, open a terminal and run the following command:

```bash
curl -fsSL https://pixi.sh/install.sh | bash
# or with brew
Expand Down Expand Up @@ -102,7 +106,7 @@ echo 'pixi completion --shell fish | source' >> ~/.config/fish/config.fish
echo 'eval (pixi completion --shell elvish | slurp)' >> ~/.elvish/rc.elv
```

For PowerShell on Windows:
For PowerShell on Windows: Run the following command and then restart the shell or source the shell config file:
adarsh-jha-dev marked this conversation as resolved.
Show resolved Hide resolved

```pwsh
Add-Content -Path $PROFILE -Value '(& pixi completion --shell powershell) | Out-String | Invoke-Expression'
Expand Down Expand Up @@ -160,17 +164,17 @@ Commands:
completion Generates a completion script for a shell
init Creates a new project
add Adds a dependency to the project
run Runs task in project
shell Start a shell in the pixi environment of the project
global Global is the main entry point for the part of pixi that executes on the global(system) level
run Runs a task in the project
shell Start a shell in the `pixi` environment of the project
global Global is the main entry point for the part of `pixi` that executes on the global (system) level
auth Login to prefix.dev or anaconda.org servers to access private channels
install Install all dependencies
task Command management in project
task Command management in the project
info Information about the system and project
upload Upload a package to a prefix.dev channel
search Search a package, output will list the latest version of package
search Search a package; output will list the latest version of the package
project
help Print this message or the help of the given subcommand(s)
help Print this message or the help for the given subcommands
adarsh-jha-dev marked this conversation as resolved.
Show resolved Hide resolved

Options:
-v, --verbose... More output per occurrence
Expand Down