Skip to content

Commit

Permalink
Add compilation steps to README.md
Browse files Browse the repository at this point in the history
Authored-by: Joydeep Tripathy <[email protected]>
  • Loading branch information
joydeep049 authored May 8, 2024
1 parent 7dfb21f commit ffaadb0
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,10 @@ There is also (as yet unmerged) support for [integration with riscv-config](http
For booting operating system images, see the information under the
[os-boot/](os-boot/) subdirectory.
### How to use the out-of-tree JSON backend to generate JSON from Sail
For details, see [JSON.md](doc/JSON.md).
### Using development versions of Sail
Rarely, the version of Sail packaged in opam may not meet your needs. This could happen if you need a bug fix or new feature not yet in the released Sail version, or you are actively working on Sail. In this case you can tell the `sail-riscv` `Makefile` to use a local copy of Sail by setting `SAIL_DIR` to the root of a checkout of the Sail repo when you invoke `make`. Alternatively, you can use `opam pin` to install Sail from a local checkout of the Sail repo as described in the Sail installation instructions.
Expand Down
18 changes: 18 additions & 0 deletions doc/JSON.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
STEPS TO BUILD AND COMPILE THE PROJECT
=======================================

After Installing the prerequisites

1. We first need to build the sail parser.
1. Find a directory to clone this repository, and make that directory your current working directory.
2. `git clone https://github.com/ThinkOpenly/sail`
3. `cd sail`
4. `make`

2. Then, set up the environment for building in the RISC-V Sail repository:
1. `eval $(opam env)`
2. `export PATH=<path-to-sail-repository>:$PATH`

3. Clone this sail-riscv repository.

4. Within that clone : `make json`

0 comments on commit ffaadb0

Please sign in to comment.