From 896c70226b6387b93208e98e12509cc9cca52fee Mon Sep 17 00:00:00 2001 From: FeepingCreature Date: Sat, 24 Feb 2024 08:56:39 +0100 Subject: [PATCH] Add "get started" entry for Windows --- doc/sphinx/getstarted.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/sphinx/getstarted.rst b/doc/sphinx/getstarted.rst index 27af17c..a6a0db0 100644 --- a/doc/sphinx/getstarted.rst +++ b/doc/sphinx/getstarted.rst @@ -16,6 +16,34 @@ differences of LLVM's and gcc's backend, both Neat backends are equally capable. The installation instructions assume, and are tested with, Ubuntu 22.04. Take required steps as equivalent for your system. +Install on Windows +------------------ + +Warning: as I don't have any Windows computer around, very little testing effort has gone into this deployment. +The testsuite passes on Wine, that's about all I can say. + +1. Install `llvm-mingw with LLVM 15 `_. + +2. Ensure that the 'bin' folder of llvm-mingw distro is in the `PATH`. + +3. Download the latest win64-gcc release from https://github.com/neat-lang/neat/releases + +4. Execute `build.bat`. This should (eventually) create a file `neat.exe`. + +5. Test the compiler: save a file 'hello.nt':: + + module hello; + import std.stdio; + void main() { print("Hello World"); } + +Then compile it with:: + + neat hello.nt + hello.exe + +If that printed "Hello World", your Neat compiler is now ready for use! + + Install with LLVM -----------------