https://github.com/mithro/litex-all
https://github.com/mithro/litex-all
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mithro/litex-all
- Owner: mithro
- Created: 2020-02-21T19:35:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-21T23:01:17.000Z (over 6 years ago)
- Last Synced: 2025-07-02T16:13:03.345Z (11 months ago)
- Language: Python
- Size: 11.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Setting Up
## Installing
To install the LiteX ecosystem you need to;
1. Make sure you have all the git submodules.
2. Then for each CPU type you wish to use with LiteX you will need to;
* Use `pip` to install the requirements for the given CPU
`requirements.CPU.txt` (For example, `requirements.vexriscv.txt`).
* Install a C compiler to be used with the given CPU.
### Installing as a user
To install as a user, make sure you supply `--user` to the
```shell-session
# Make sure you have all the submodules
git submodule update --init --recursive
# Install the requirements for the CPUs you want to use, this will also install
# any common requirements.
pip install --user -r ./requirements/vexriscv.txt
# Download and install a RISCV C compiler
XXXXXX
```
### Install system wide (not recommend)
Installing system wide is **not** recommended. It does work okay on Windows.
```shell-session
# Make sure you have all the submodules
git submodule update --init --recursive
# Install the requirements for the CPUs you want to use, this will also install
# any common requirements.
sudo pip install -r ./requirements/vexriscv.txt
# Download and install a RISCV C compiler
XXXXXX
```
### Using a virtual env
```shell-session
# Make sure you have all the submodules
git submodule update --init --recursive
# Setup virtualenv
virtualenv --python=python3 venv
source venv/bin/activate
# Install the requirements for the CPUs you want to use, this will also install
# any common requirements.
pip install -r ./requirements/vexriscv.txt
# Download and install a RISCV C compiler
XXXXXX
```
### Using conda
```shell-session
# Make sure you have all the submodules
git submodule update --init --recursive
# Create a conda environment
conda env create --name litex --path env
conda activate litex
# Install the requirements for the CPUs you want to use, this will also install
# any common requirements.
pip install -r ./requirements/vexriscv.txt
# Download and install a RISCV C compiler
conda install gcc-cross-rv32
```
# Using LiteX for your project
There are a couple of ways to use LiteX for your project.
## Submodule in the whole LiteX ecosystem
```shell-session
# Create an initial commit
git init
touch README.md
git add README.md
git commit -m"First commit"
# Submodule in the whole LiteX ecosystem
git submodule add https://github.com/enjoy-digital/litex.git third_party/litex
# Set up your requirements.txt file
cat > requirements.txt < requirements.txt <