feat: Update documentation to clarify Nix usage and enhance onboarding for non-Nix contributors

This commit is contained in:
2026-05-23 18:17:47 -05:00
parent 94c7cadcd7
commit 2ecab4db12
4 changed files with 21 additions and 8 deletions
+14 -2
View File
@@ -1,6 +1,7 @@
# FeDIY
FeDIY provides a reproducible Rust development environment using Nix flakes and the fenix toolchain.
Nix is optional for contributors: if you use it, `nix develop` gives you the exact tools this repository expects without needing to install them globally. If you do not use Nix, you can still work with the standard Rust toolchain.
## Quick Start
@@ -19,11 +20,18 @@ When you enter the devShell (via `direnv allow` or `nix develop`), the following
No manual setup needed! Just start coding.
## Quickstart
## First Steps
```sh
nix develop
cargo build
cargo test
```
If you want a quick overview of what the shell provides, run:
```sh
nix run .#dev-helper
```
## Flatpak Packaging
@@ -67,6 +75,10 @@ flatpak run com.moturpin.fediy
| **cargo-edit** | Add/remove/upgrade Cargo dependencies from the CLI |
| **cargo-watch** | Auto-rebuild on file changes |
| **flatpak-builder** | Build Flatpak distribution packages |
| **psql / postgresql** | Local PostgreSQL development and inspection |
| **gettext** | Localization and translation workflow support |
| **chromium / playwright** | Browser-based UI and accessibility checks |
| **podman / podman-compose / buildah** | Linux-only OCI/container tooling |
| **pre-commit** | Run pre-commit hooks |
## Testing & Development Features
@@ -141,7 +153,7 @@ See project.toml for example metadata.
## Helper Tools
- **`nix run .#dev-helper`** - Display tool versions and availability
- **`nix run .#dev-helper`** - Display tool versions and availability, grouped by task
- **`cargo build`** - Build the project
- **`cargo check`** - Quick syntax check without building
- **`cargo doc --open`** - Generate and view documentation