Skip to content

Commit 03aacad

Browse files
committed
Update readme
1 parent 6b81ca5 commit 03aacad

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Lightstorm (working name)
22

3-
Simplified version of Firestorm targeting C instead of machine code directly.
3+
Simplified version of [Firestorm](https://www.youtube.com/watch?v=NfMX-dFMSr0) targeting C instead of machine code directly.
44

5-
## Local Build Setup
5+
## Development Setup
6+
7+
You can either use a codespace or a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers). For a local setup, follow the steps below.
68

79
### Install Dependencies
810

@@ -14,7 +16,7 @@ On macOS:
1416
brew install ninja cmake hyperfine llvm@19
1517
```
1618

17-
On Ubuntu 24.04:
19+
On Ubuntu:
1820

1921
```bash
2022
sudo apt-get install ninja-build cmake
@@ -28,7 +30,9 @@ To install LLVM 19 follow the instructions [here](https://apt.llvm.org).
2830
git clone git@github.com:DragonRuby/lightstorm.git --recursive
2931
```
3032

31-
### Build & install
33+
## Hello World
34+
35+
### Build lightstorm binaries/runtime
3236

3337
```bash
3438
# On Ubuntu
@@ -37,7 +41,7 @@ cmake --workflow --preset lightstorm-ubuntu-install
3741
cmake --workflow --preset lightstorm-macos-install
3842
```
3943

40-
## Build "Hello World"
44+
### Compile and run "Hello World" program
4145

4246
```bash
4347
> echo 'puts "Hello, Lightstorm"' > hello.rb
@@ -57,7 +61,7 @@ Build a test (`tests/integration/loads.rb`):
5761
```bash
5862
> cd build.dir
5963
> ninja loads.rb.exe
60-
> ../lightstorm/tests/integration/Output/loads.rb.tmp.exe
64+
> ../tests/integration/Output/loads.rb.tmp.exe
6165
1
6266
-1
6367
42

0 commit comments

Comments
 (0)