Procházet zdrojové kódy

Small document fixes for test kernel

luojia65 před 4 roky
rodič
revize
fb24b61f73
1 změnil soubory, kde provedl 11 přidání a 0 odebrání
  1. 11 0
      README.md

+ 11 - 0
README.md

@@ -12,6 +12,8 @@ See [releases](https://github.com/luojia65/rustsbi/releases).
 
 Binaries are available for platforms which can be found on
 [platform support page](https://github.com/luojia65/rustsbi/tree/master/platform).
+These provided binaries are only for reference on experiments, consider writing your own
+RustSBI implementation on production use.
 
 ## Features
 
@@ -24,6 +26,15 @@ Binaries are available for platforms which can be found on
 - Backward compatible to privileged spec v1.9
 - Supports Kendryte K210 with MMU and S-Mode
 
+## Components
+
+The RustSBI project contains three parts: the RustSBI library `rustsbi`, reference implementation
+in `platform`, and a simple operating system kernel to test SBI implementations in `test-kernel`.
+
+The test kernel is under development. Boot this kernel using your platform,
+it will call all SBI calls and run instructions to test if underlying SBI environment is okay.
+if this kernel reports 'Ok' and exits normally, it means that your SBI implementation is correct.
+
 ## Talks and documents
 
 This project is originally a part of rCore Summer of Code 2020 activities, now it is