Documentation/index.mdwn

   1 # Documentation
   2 ## Codebase Structure
   3
   4 The SOC is partitioned into three repositories at the moments.
   5
   6 | Git Repo | Documentation |
   7 |----------|---------------|
   8 | [SOC](https://git.libre-soc.org/?p=soc.git;a=tree) | [SOC Docs](/SOC/index) |
   9 | [FPU](https://git.libre-soc.org/?p=ieee754fpu.git;a=tree) | -- |
  10 | [nmutil](https://git.libre-soc.org/?p=nmutil.git;a=tree) | -- |
  11
  12 ## Installing the Codebase
  13
  14     pip3 install virtualenv requests
  15     mkdir ~/.virtualenvs && cd ~/.virtualenvs
  16     python3 -m venv libresoc
  17     source ~/.virtualenvs/bin/activate
  18
  19     cd ~; mkdir libresoc; cd libresoc
  20     git clone https://git.libre-riscv.org/git/nmutil.git
  21     git clone https://git.libre-riscv.org/git/ieee754fpu.git
  22     git clone https://git.libre-riscv.org/git/soc.git
  23
  24     cd nmutil; pip3 install -e .; cd ..
  25     cd ieee754fpu; pip3 install -e .; cd ..
  26     cd soc; pip3 install -e .; cd ..
  27
  28     python3 soc/src/soc/decoder/power_decoder.py
  29     yosys -p "read_ilang decoder.il; show dec31"