Skip to content

Commit

Permalink
infra: Adding 'Getting Started' scripts and updating README
Browse files Browse the repository at this point in the history
Signed-off-by: David Shah <[email protected]>
  • Loading branch information
gatecat committed May 19, 2018
1 parent 5221334 commit cb3c0a9
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ ispTcl.log.*
ispTcl.tcl
ispTcl.tcl.*
.ispTcl.lock
work_*/
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,25 @@ the bitstream format for the Xilinx Series 7 devices.

# Quickstart Guide

Currently Project Trellis is tested on Arch Linux and Ubuntu 17.10.

Install the dependencies:
- Lattice Diamond 3.10
- Python 3.5 or later, including development libraries (`python3-dev` on Ubuntu)
- A modern C++14 compiler (g++ or Clang recommended)
- Boost
- CMake 3.8 or later
- Boost including boost-python

Pull submodules:

git submodule update --init --recursive

For a generic environment:

source environment.sh

Optionally, modify `user_environment.sh` and rerun the above command if needed.

Get a head start by downloading current database:

# Give the argument;
Expand All @@ -36,13 +45,11 @@ Get a head start by downloading current database:
# - git if you want to use the git protocol
./download-latest-db.sh

For a generic environment:
Alternatively, if you want to start from scratch:

source environment.sh

TODO: device specific environments, like X-ray
./create-empty-db.sh

Build libtrellis:
Build and test libtrellis:

cd libtrellis
cmake .
Expand Down
7 changes: 7 additions & 0 deletions create-empty-db.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash
rm -rf database
mkdir -p database
echo '*' > database/.gitignore
cp devices.json database/
python3 tools/get_tilegrid_all.py
python3 tools/create_empty_bitdbs.py
7 changes: 7 additions & 0 deletions download-latest-db.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash

GITHUB_PROTO=${1:-https}
GITHUB_URL=$GITHUB_PROTO://github.com/SymbiFlow/prjtrellis-db.git
rm -rf database
git clone $GITHUB_URL database
echo '*' > database/.gitignore

0 comments on commit cb3c0a9

Please sign in to comment.