Skip to content

Commit

Permalink
Fixes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HAKarlsson committed Nov 2, 2023
1 parent f05d035 commit 37c14af
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
s3k - Simple Secure Separation Kernel
S3K - Simple Secure Separation Kernel
=====================================

s3k is a separation kernel targetting embedded RISC-V systems.
S3K is a capability-based separation kernel targetting embedded RISC-V systems.

- [Documentation Index](https://github.com/kth-step/s3k/wiki)
Documentation:
- [Home](https://github.com/kth-step/s3k/wiki)
- [S3K Design](https://github.com/kth-step/s3k/wiki/S3K-Design)
- [S3K API](https://github.com/kth-step/s3k/wiki/S3K-API)

More documenation will be added.

Configuration
-------------

Set your compiler toolchain in `tools.mk`. By default we have the following:
```
CC=riscv64-unknown-elf-gcc
AR=riscv64-unknown-elf-ar
LD=riscv64-unknown-elf-ld
SIZE=riscv64-unknown-elf-size
OBJDUMP=riscv64-unknown-elf-objdump
OBJCOPY=riscv64-unknown-elf-objcopy
CC =riscv64-unknown-elf-gcc
AR =riscv64-unknown-elf-ar
LD =riscv64-unknown-elf-ld
SIZE =riscv64-unknown-elf-size
OBJDUMP =riscv64-unknown-elf-objdump
OBJCOPY =riscv64-unknown-elf-objcopy
```

Build and Run
Expand Down Expand Up @@ -73,7 +76,5 @@ Repository structure
- hello - Hello, world example with two processes
- ping-ping - IPC example
- trapped - Trap handling example
- wcet - deprecated project (for now)
- API.md - Kernel API
- LICENSE - MIT License file
- tools.mk - Set the compiler tools here

0 comments on commit 37c14af

Please sign in to comment.