Skip to content

Commit

Permalink
cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
saursin committed Feb 5, 2024
1 parent 7ecef81 commit 9392ff2
Showing 1 changed file with 1 addition and 40 deletions.
41 changes: 1 addition & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,48 +21,9 @@ Key highlights of the RISC-V Atom projects are are listed below:
- Open source under [MIT License](https://en.wikipedia.org/wiki/MIT_License).


> ***To checkout this project, Please refer to the [Getting Started Guide](https://riscv-atom.readthedocs.io/en/latest/pages/getting-started/riscv-atom.html)***:
> ***To checkout this project, Please refer to the [Getting Started Guide](https://riscv-atom.readthedocs.io/en/latest/pages/getting-started/riscv-atom.html)***.
> ***Use the `dev` branch, if you like to see the latest additions to the project***
## Directory Structure

- `docs` : RISCV-Atom documentation: ([readthedocs](https://riscv-atom.readthedocs.io/en/latest/index.html))

- `rtl` : Verilog sources.
- `core` : RISCV-Atom core components.
- `uncore` : RISCV-Atom non-core components (peripherals).
- `dpi` : SystemVerilog DPI sources.
- `soc` : SoC implementations
- `tb` : Testbenches

- `scripts` : utility scripts.

- `sim` : Atomsim source code.
- `build` : Atomsim build files (autogenerated).
- `docs` : Doxygen Documentation for Atomsim source code.
- `include` : external libraries for atomsim.

- `sw` : RISCV-Atom software sources
- `bootloader` : RISC-V Atom bootloader.
- `examples` : RISCV-Atom examples
- `lib` : libc for RISCV-Atom
- `include` : libcatom headers
- `libcatom` : libcatom sources
- `link` : RISC-V Atom linker scripts

- `synth` :
- `xilinx`: Synthesis project for xilinx FPGAs
- `yosys` : Yosys synthesis scripts

- `test` : RISCV Atom tests
- `riscv-target` : Official RISC-V compliance test files
- `scar` : SCAR tests directory

- `tools` : utility tools
- `elfdump` : elfdump utility


## Useful Links
1. [Project Website](https://sites.google.com/view/saurabh-singh-web/projects/risc-v-atom?authuser=0)
2. [Project Documentation](https://riscv-atom.readthedocs.io/en/latest/index.html)
Expand Down

0 comments on commit 9392ff2

Please sign in to comment.