Skip to content

Commit c5bf281

Browse files
committed
docs: add Nix installation and development setup to README
Add Nix as the recommended development setup with instructions for entering the dev environment, formatting, and running checks. Benefits of using Nix: - Automatic dependency installation - Git hooks auto-configured - Consistent environment across platforms
1 parent 283dded commit c5bf281

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,29 @@ StackOne AI provides a unified interface for accessing various SaaS tools throug
2929

3030
## Installation
3131

32+
### Using Nix (Recommended for Development)
33+
34+
If you have [Nix](https://nixos.org/) installed with flakes enabled:
35+
36+
```bash
37+
# Enter development environment (auto-installs dependencies and git hooks)
38+
nix develop
39+
40+
# Format code
41+
nix fmt
42+
43+
# Run checks
44+
nix flake check
45+
```
46+
47+
The Nix development environment includes:
48+
- Python with uv package manager
49+
- Automatic dependency installation
50+
- Git hooks (treefmt + mypy) auto-configured
51+
- Consistent environment across all platforms
52+
53+
### Using pip/uv
54+
3255
### Basic Installation
3356

3457
```bash

0 commit comments

Comments
 (0)