From 0b55a90a388e329d9e10029e65973dd01a83d684 Mon Sep 17 00:00:00 2001 From: Alexander Medvedev Date: Thu, 8 Aug 2024 14:33:15 +0200 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 3eb27fbc..b370206d 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,20 @@ Pumpkin is currently under heavy development. Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/1) to see current progress +## How to run +There are currently no release builds, because there was no release :D. + +To get Pumpkin running you first have to clone it: +``` +git clone https://github.com/Snowiiii/Pumpkin.git +cd Pumpkin +``` +You also may have to [install rust](https://www.rust-lang.org/tools/install) when you don't already have. +Then run it: +``` +cargo run --release +``` + ## Contributions Contributions are welcome!. See [CONTRIBUTING.md](CONTRIBUTING.md)