Merge pull request #40 from SpinalHDL/cleanup

Cleanup

.github/workflows/push-docs.yml

@@ -0,0 +1,34 @@
+name: "Push scaladoc on gh-pages"
+
+on:
+  push:
+    branches:
+      - dev
+  release:
+    types:
+      - published
+
+jobs:
+  push-docs:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 30
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Setup JDK
+      uses: actions/setup-java@v3
+      with:
+        distribution: temurin
+        java-version: 17
+        cache: sbt
+    - name: Build scaladoc
+      run: sbt clean doc
+    - name: Deploy 🚀
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        folder: target/scala-2.12/api
+        target-folder: ${{ github.ref_name }}
+        single-commit: true

README.md

@@ -3,16 +3,20 @@
 VexiiRiscv (Vex2Risc5) is the successor of VexRiscv. Work in progress, here are its currently implemented features :
 
 - RV32/64 I[M][A][F][D][C][S][U][B]
-- Up to 5.24 coremark/Mhz 2.50 dhystone/Mhz (WIP)
+- Up to 5.24 coremark/Mhz 2.50 dhystone/Mhz
 - In-order execution
 - early [late-alu]
 - single/dual issue (can be asymmetric)
 - BTB, GShare, RAS branch prediction
-- cacheless fetch/load/store, I$, D$ (WIP)
-- optional SV32/SV39 MMU
-- Can run linux / buildroot
+- cacheless fetch/load/store
+- Optional I$, D$
+- Optional SV32/SV39 MMU
+- Can run linux / buildroot / Debian
 - Pipeline visualisation in simulation via Konata
 - Lock step simulation via RVLS and Spike
+- ... and many other things
+
+Here is a demonstration of a quad core VexiiRiscv running debian on FPGA : https://youtu.be/dR_jqS13D2c?t=112
 
 Overall the goal is to have a design which can stretch (through configuration) from Cortex M0 up to a Cortex A53 and potentialy beyond.
 
@@ -21,6 +25,10 @@ Here is the online documentation :
 - https://spinalhdl.github.io/VexiiRiscv-RTD/master/VexiiRiscv/Introduction/#
 - https://spinalhdl.github.io/VexiiRiscv-RTD/master/VexiiRiscv/HowToUse/index.html
 
+Here is the VexiiRiscv's scala doc (auto-generated from the source code) :
+
+- https://spinalhdl.github.io/VexiiRiscv/doc/vexiiriscv/index.html
+
 A roadmap is available here : 
 
 - https://github.com/SpinalHDL/VexiiRiscv/issues/1

doc/litex/alpine/README.md

@@ -1,6 +1,17 @@
-https://blog.ari.lt/b/how-to-manually-install-alpine-linux-on-any-linux-distribution/
-https://wiki.gentoo.org/wiki/OpenRC_to_systemd_Cheatsheet
+# Getting Alpine linux to run on RISC-V
 
+So this README compile a set of command lines which were used to get it up on running on the VexiiRiscv RV64GC litex SoC.
+You can find most of the fundamental informations on the links bellow : 
+
+- https://blog.ari.lt/b/how-to-manually-install-alpine-linux-on-any-linux-distribution/
+- https://wiki.gentoo.org/wiki/OpenRC_to_systemd_Cheatsheet
+
+Overall, if you have a system which can run Debian, then it should be able to run Alpine without issues.
+The one tricky thing with alpine linux is that the image you can download generaly need a few tweeks using chroot to be functional.
+
+## Image setup 
+
+```bash
 cd /media/rawrr/rootfs
 sudo rm -rf *
 sudo tar xpvf /media/data2/download/alpine-minirootfs-3.20.1-riscv64.tar.gz --xattrs-include='*.*' --numeric-owner
@@ -15,18 +26,22 @@ rc-update add loadkeys boot
 rc-update add chronyd boot
 
 apk add xf86-video-fbdev xterm
+```
 
-setup-keymap ch fr 
+## Scrap commands
 
+```bash
+setup-keymap ch fr
 XKBMODEL="pc105"
 XKBLAYOUT="ch"
 XKBVARIANT="fr"
 XKBOPTIONS=""
+
 mount -o remount,rw /
 
 kbd-bkeymaps
 
 loadkeys ch-fr
 
 apk add chocolate-doom --repository=https://dl-cdn.alpinelinux.org/alpine/edge/testing
-
+```

doc/litex/buildroot/README.md

@@ -2,6 +2,11 @@
 
 This readme document (from scratch) how to generate all the images to run buildroot Litex + VexiiRiscv.
 
+The hardware requirements are to have : 
+- RV32IMA CPU
+- Some RAM (64 MB)
+- SDCARD support
+
 ## Setup environnement variables
 
 ```shell

doc/litex/debian/README.md

@@ -2,6 +2,11 @@
 
 This readme document (from scratch) how to generate all the images to run debian Litex + VexiiRiscv.
 
+The hardware requirements are to have :
+- RV64IMAFDC CPU
+- A good amount of RAM (128 MB)
+- SDCARD support
+
 ## Setup environnement variables
 
 ```shell