docs: add faq

prefix-dev · Nov 6, 2023 · 236ad3e · 236ad3e
1 parent 699fe4d
commit 236ad3e
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 1 deletion.
diff --git a/docs/FAQ.md b/docs/FAQ.md
@@ -0,0 +1,33 @@
+
+## What is the difference with `conda`, `mamba`, `poetry`, `pip`
+
+| Tool   | Installs python | Builds packages          | Runs predefined tasks | Has lockfiles builtin | Fast | Use without python                                                     |
+|--------|-----------------|--------------------------|-----------------------|-----------------------|------|------------------------------------------------------------------------|
+| Conda  | ✅               | ❌                        | ❌                     | ❌                     | ❌    | ❌                                                                      |
+| Mamba  | ✅               | ❌                        | ❌                     | ❌                     | ✅    | [✅](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) |
+| Pip    | ❌               | ✅                        | ❌                     | ❌                     | ❌    | ❌                                                                      |
+| Pixi   | ✅               | [🚧](under construction) | ✅                     | ✅                     | ✅    | ✅                                                                      |
+| Poetry | ❌               | ✅                        | ❌                     | ✅                     | ❌    | ❌                                                                      |
+
+
+## Why the name `pixi`
+Starting with the name `prefix` we iterated until we had a name that was easy to pronounce, spell and remember.
+There also wasn't a cli tool yet using that name.
+Unlike `px`, `pex`, `pax`, etc.
+We think it sparks curiosity and fun, if you don't agree, I'm sorry, but you can always alias it to whatever you like.
+
+=== "Linux & macOS"
+    ```shell
+    alias not_pixi="pixi"
+    ```
+=== "Windows"
+    PowerShell:
+    ```powershell
+    New-Alias -Name not_pixi -Value pixi
+    ```
+
+## Where is `pixi build`
+**TL;DR**: It's coming we promise!
+
+`pixi build` is going to be the subcommand that can generate a conda package out of a pixi project.
+This requires a solid build tool which we're creating with [`rattler-build`](https://github.com/prefix-dev/rattler-build) which will be used as a library in pixi.
diff --git a/docs/index.md b/docs/index.md
@@ -23,6 +23,7 @@ To install `pixi` you can run the following command in your terminal:
     The script will also update your `~/.bash_profile` to include `~/.pixi/bin` in your PATH, allowing you to invoke the `pixi` command from anywhere.
 
 === "Windows"
+    PowerShell:
     ```powershell
     iwr -useb https://pixi.sh/install.ps1 | iex
     ```
@@ -51,6 +52,7 @@ To get autocompletion run:
     echo 'eval (pixi completion --shell elvish | slurp)' >> ~/.elvish/rc.elv
     ```
 === "Windows"
+    PowerShell:
     ```powershell
     Add-Content -Path $PROFILE -Value '(& pixi completion --shell powershell) | Out-String | Invoke-Expression'
     ```

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -60,11 +60,12 @@ nav:
     - Tasks: advanced/advanced_tasks.md
     - Multi Platform: advanced/multi_platform_configuration.md
     - Info command: advanced/explain_info_command.md
-  - Community: Community.md
   - Examples:
       - C++/Cmake: examples/cpp-sdl.md
       - OpenCV: examples/opencv.md
       - ROS2: examples/ros2-nav2.md
+  - Community: Community.md
+  - FAQ: FAQ.md
 
 
 plugins: