Good for newcomers

TimVideos.us has done an awesome job for setting up a LiteX environment easily in the litex-buildenv repo: https://github.com/timvideos/litex-buildenv

It's recommended for newcomers to go this way. Various FPGA boards are supported and multiple examples provided! You can even run Linux on your FPGA using LiteX 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

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

Only for advanced users

0. Install Python 3.5+ and FPGA vendor's development tools.

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`
   ../configure --target=lm32-elf
   make
   make install
   

3. Compile and install GCC. Take gcc-core and gcc-g++ from GNU

   rm -rf libstdc++-v3
   mkdir build && cd build
   ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc \
       --disable-libssp
   make
   make install
   

4. Build the target of your board...: Go to boards/targets and execute the target you want to build

5. ... and/or install Verilator and test LiteX on your computer: Download and install Verilator: http://www.veripool.org/ Install libevent-devel / json-c-devel packages Go to boards/targets ./sim.py

6. Run a terminal program on the board's serial port at 115200 8-N-1. You should get the BIOS prompt.