vexriscv: update
[litex.git] / README
diff --git a/README b/README
index 02fdb5f59ff9d52dbd1328129d56f21d6346b71e..562de2163a836bf95663616bb3dbf8a62d218255 100644 (file)
--- a/README
+++ b/README
@@ -36,6 +36,21 @@ Typical LiteX design flow:
                            file    file
 
 
+LiteX already supports various softcores CPUs: LM32, Mor1kx, PicoRV32, VexRiscv
+and is compatible with the LiteX's Cores Ecosystem:
+
+- LiteDRAM: https://github.com/enjoy-digital/litedram
+- LiteEth: https://github.com/enjoy-digital/liteeth
+- LitePCIe: https://github.com/enjoy-digital/litepcie
+- LiteSATA: https://github.com/enjoy-digital/litesata
+- LiteUSB: https://github.com/enjoy-digital/litesata
+- LiteSDCard: https://github.com/enjoy-digital/litesdcard
+- LiteICLink: https://github.com/enjoy-digital/liteiclink
+- LiteJESD204B: https://github.com/enjoy-digital/litejesd204b
+- LiteVideo: https://github.com/enjoy-digital/litevideo
+- LiteScope: https://github.com/enjoy-digital/litescope
+
+
 [> Sub-packages
 ---------------
 gen:
@@ -51,7 +66,8 @@ soc:
   to build a SoC from such cores.
 
 boards:
-  Provides platforms and targets for the supported boards.
+  Provides platforms and targets for the supported boards. All Migen's platforms
+  can also be used in LiteX.
 
 [> Very Quick start guide (for newcomers)
 -----------------------------------------
@@ -64,14 +80,35 @@ very easily!
 
 Migen documentation can be found here: https://m-labs.hk/migen/manual
 
+FPGA lessons/tutorials can be found at: https://github.com/enjoy-digital/fpga_101
+
+[> Medium Quick start guide with Conda
+-----------------------------------------
+
+0. Get miniconda by following instructions at https://conda.io/miniconda.html
+
+1. Clone LiteX
+  git clone --recurse-submodules https://github.com/enjoy-digital/litex.git
+
+2. Create a LiteX environment from environment.yml
+  conda env create -f environment.yml
+
+3. Enter conda environment
+  conda activate litex
+
+4. Build the target of your board...:
+  Go to boards/targets and execute the target you want to build
+
 
 [> Quick start guide (for advanced users)
 -----------------------------------------
-0. If cloned from Git without the --recursive option, get the submodules:
-  git submodule update --init
+0. Install Python 3.5+ and FPGA vendor's development tools.
 
-1. Install Python 3.5, Migen and FPGA vendor's development tools.
-   Get Migen from: https://github.com/m-labs/migen
+1. Get litex_setup.py script and execute:
+   ./litex_setup.py init install
+   This will clone and install Migen, LiteX and LiteX's cores.
+   To update all repositories execute:
+   ./litex_setup.py update
 
 2. Compile and install binutils. Take the latest version from GNU.
   mkdir build && cd build
@@ -103,4 +140,4 @@ Migen documentation can be found here: https://m-labs.hk/migen/manual
 
 [> Contact
 ----------
-E-mail: florent [AT] enjoy-digital.fr
\ No newline at end of file
+E-mail: florent [AT] enjoy-digital.fr