From ac364caedeaa4f8da05485773f85eeae5978d13e Mon Sep 17 00:00:00 2001 From: Olivia Brooks <109807080+Cutieguwu@users.noreply.github.com> Date: Mon, 26 Jan 2026 14:31:34 -0500 Subject: [PATCH] Add Getting Started guide; update Future Plans; add WSL warning. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 33f6be1..1cb8691 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,22 @@ worked out over time. `raven` is only tested under linux. NT and Darwin support is **not** guaranteed. +WSL *may* affect the behaviour of raven. Quirks to be worked out. + +## Getting Started + +```bash +raven new demo +cd demo +raven run main.Main +``` + ## Future plans +- [ ] Fix `raven test`. Totally borked. - [ ] Make `nest run` fall back to an entry point specified in Nest.toml, when none provided. +- [ ] Fix project structure, eliminate inter-dependencies. + - [ ] Separate out `java.rs` into a dedicated wrapper library. - [ ] Possibly add support for pulling remote packages via `nest add`. This will be implemented should there arise a need.