Getting Started with Incan¶
Prerequisites¶
- Rust (1.85+): install via rustup
git: to clone the repositorymake: for the canonical make-first workflow
These instructions assume a Unix-like shell environment (macOS/Linux). If you’re on Windows, use WSL:
- WSL install guide:
https://learn.microsoft.com/windows/wsl/install
Install/build/run (canonical)¶
Follow: Install, build, and run.
Your First Program¶
Create a file hello.incn:
def main() -> None:
println("Hello, Incan!")
Run it:
If you used make install:
incan run hello.incn
If you used the no-install fallback:
./target/release/incan run hello.incn
Project Structure¶
A typical Incan project is just a folder of .incn files (and optionally tests/):
my_project/
├── src/
│ ├── main.incn # Entry point
│ └── utils.incn # Additional modules
├── tests/
│ └── test_utils.incn
└── incan.toml # Project config (planned)
Note: incan.toml is planned and not required to get started today.
Next Steps¶
- Formatting Guide - Code style and
incan fmt - CLI Reference - Commands, flags, and environment variables
- Projects today - Where builds go, what is regenerated, and what’s planned
- Troubleshooting - Common setup and “it didn’t work” fixes
- Language: Start here - Learn Incan syntax and patterns
- Stability policy - Versioning expectations and “Since” semantics
- Examples - Sample programs