Browse Source

Add information on building manually with `just`

luojia65 4 years ago
parent
commit
911867af00
2 changed files with 20 additions and 3 deletions
  1. 2 2
      README.md
  2. 18 1
      platform/README.md

+ 2 - 2
README.md

@@ -12,8 +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 to write your own
-RustSBI implementation on production use.
+This page includes an instruction to write your own RustSBI implementation on production use,
+and some reference implementations for experiments and reference.
 
 ## Features
 

+ 18 - 1
platform/README.md

@@ -11,11 +11,28 @@ P: Pending
 
 ## Notes for binary releases
 
-These platforms implementations are only for reference.
+These platform implementations are only for reference.
 Although binaries are released along with RustSBI library itself,
 platform developers should consider using RustSBI as a library,
 other than adding code into forked project's 'platforms' and make a pull request.
 
+Tshe RustSBI project will release these platform binaries in release page.
+Normally, a RustSBI implementation is a separate project other than squashed into 'platform' path;
+but if you really want to contribute to these reference implementations, you may need to build these
+platform packages by yourself.
+
+### Build and install
+
+To build provided reference platforms, you should install the command runner `just`.
+Like `make`, `just` is a handy way to save and run project specific commands.
+To install just, refer to `just` packages [link](https://github.com/casey/just#packages) and pick
+a install command according to your operating system used for development.
+
+Each reference platform have provided `justfile` configuration file.
+You may `cd` into project path and run command `just build` to build binary package.
+The binary package should be ready in some place under `target` folder.
+Or, use `just run` to build and execute it in emulator with a test kernel.
+
 ## Support your own platform
 
 There are RISC-V cores, SoC's, and boards, we can not support them one by one with any software,