Skip to content

Commit a5d97e5

Browse files
zrr1999Copilot
andcommitted
chore: align examples, docs, and CI validation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0a0fd7f commit a5d97e5

3 files changed

Lines changed: 8 additions & 4 deletions

File tree

.github/workflows/ci-tests.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ jobs:
4343
- uses: actions/checkout@v6
4444
with:
4545
repository: spore-lang/spore
46+
ref: f36d507f3dd33f61e26b9cdc382e855889172667
4647
path: _spore
4748

4849
- uses: dtolnay/rust-toolchain@stable
@@ -81,6 +82,9 @@ jobs:
8182
fi
8283
find "${paths[@]}" -name '*.sp' -type f | sort | xargs -n 1 _spore/target/release/spore build
8384
85+
- name: Run hello example
86+
run: _spore/target/release/spore run examples/hello.sp
87+
8488
- name: Run Spore spec tests
8589
run: |
8690
if [ ! -d tests ]; then

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Operating System
2323
| `Stdout` | `uses [Console]` | Standard output |
2424
| `Stdin` | `uses [Console]` | Standard input |
2525
| `File` | `uses [FileRead]` or `uses [FileWrite]` | File system operations |
26-
| `Dir` | `uses [FileRead]` | Directory listing |
26+
| `Dir` | `uses [FileRead]` or `uses [FileWrite]` | Directory listing and creation |
2727
| `Env` | `uses [Env]` | Environment variables |
2828
| `Cmd` | `uses [Spawn]` | Process execution |
2929

@@ -76,10 +76,10 @@ If you want to add a new tutorial/example, treat this as the bar:
7676

7777
## Design Philosophy
7878

79-
Following Spore's [SEP-0005 (Effect System)](https://github.com/spore-lang/spore-evolution):
79+
Following Spore's [SEP-0003 (Effect Capability System)](https://github.com/spore-lang/spore-evolution/blob/main/seps/SEP-0003-effect-capability-system.md):
8080

8181
- **Capability-gated**: Every I/O function declares its required capabilities via `uses [Cap]`
82-
- **Cost-annotated**: Platform functions carry `cost ≤ N` budgets where meaningful
82+
- **Cost-annotated**: Platform functions can carry `cost [c, a, i, p]` budgets where meaningful
8383
- **Error-typed**: Functions declare error sets via `! ErrorType`
8484
- **Pure by default**: The platform boundary is the only place side effects occur
8585

examples/hello.sp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
/// A simple "Hello World" using the basic-cli platform.
22
///
3-
/// Run with: spore run examples/hello.sp --platform basic-cli
3+
/// Run with: spore run examples/hello.sp
44
fn main() -> () uses [Console] { println("Hello from Spore basic-cli!") }

0 commit comments

Comments
 (0)