doc: update kernel README with new version number

This commit is contained in:
Thomas Dickson
2024-10-01 11:07:13 +13:00
committed by Tate, Hongliang Tian
parent 61f6c637d2
commit 5af0fd6010
6 changed files with 23 additions and 20 deletions

View File

@ -3,7 +3,7 @@
## Overview
Asterinas is a _secure_, _fast_, and _general-purpose_ OS kernel
that provides _Linux-compatible_ ABI.
that provides an _Linux-compatible_ ABI.
It can serve as a seamless replacement for Linux
while enhancing _memory safety_ and _developer friendliness_.
@ -44,7 +44,11 @@ git clone https://github.com/asterinas/asterinas
2. Run a Docker container as the development environment.
```bash
docker run -it --privileged --network=host --device=/dev/kvm -v $(pwd)/asterinas:/root/asterinas asterinas/asterinas:0.9.0
docker run -it --privileged \
--network=host \
--device=/dev/kvm \
-v $(pwd)/asterinas:/root/asterinas \
asterinas/asterinas:0.9.0
```
3. Inside the container, go to the project folder to build and run Asterinas.

View File

@ -64,8 +64,8 @@ Then, in the interactive shell, run the following script to start the syscall te
### Using GDB to Debug
To debug Asterinas by [QEMU GDB support](https://qemu-project.gitlab.io/qemu/system/gdb.html),
one could compile Asterinas in the debug profile,
To debug Asterinas via [QEMU GDB support](https://qemu-project.gitlab.io/qemu/system/gdb.html),
you can compile Asterinas in the debug profile,
start an Asterinas instance and run the GDB interactive shell in another terminal.
Start a GDB-enabled VM of Asterinas with OSDK and wait for debugging connection:

View File

@ -18,7 +18,7 @@ which would take a significant amount of time.
To address this obstacle,
we have decided to enter the cloud market first.
In an IaaS cloud, workloads of different tenants are run in VMs
In an IaaS (Infrastructure-as-a-Service) cloud, workloads of different tenants are run in VMs
or [VM-style bare-metal servers](https://dl.acm.org/doi/10.1145/3373376.3378507)
for maximum isolation and elasticity.
The main device driver requirement for the VM environment is virtio,
@ -28,7 +28,7 @@ or the host OS of a VM-style bare-metal server in production
looks quite feasible in the near future.
Asterinas provides high assurance of memory safety
thanks to [the framekernel architecture]().
thanks to [the framekernel architecture](the-framekernel-architecture.md).
Thus, in the cloud setting,
Asterinas is attractive for usage scenarios
where Linux ABI is necessary but Linux itself is considered insecure

View File

@ -47,7 +47,7 @@ It must concurrently fulfill four criteria.
The safe APIs of the framework are considered sound
if no [undefined behaviors](https://doc.rust-lang.org/reference/behavior-considered-undefined.html#behavior-considered-undefined) shall be triggered
by whatever safe Rust code that a programmer may write using the APIs
---as long as the code is verified by the Rust toolchain.
- as long as the code is verified by the Rust toolchain.
Soundness ensures that the OS framework,
in conjunction with the Rust toolchain,
bears the full responsibility for the kernel's memory safety.