Skip to content

Commit

Permalink
Edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
recolic committed Sep 3, 2018
1 parent 1a1d26b commit caa5638
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

> Run vivado natively in linux command line.
## Features

- Init, build, burn any vivado project in one command.

- Burn auto saved built binary at anytime and any machine.

- Full vivado GUI support.

- Support every hardware supported by vivado.

- Theoretically support any vivado version (But latest is the best).

## Installation

```sh
Expand All @@ -26,13 +38,11 @@ alias vivadow=vivado-wrapper # I'll use this wrapper in the doc below.
mkdir my_project && cd my_project
vivadow init
code . # Or any editor you prefer.
vim Vivadofile # To tell vivado-wrapper about your module~constraint relationship.
vim Vivadofile # To tell vivado-wrapper about your module~constraint relationship, threads, board, etc.
```

- Build Project

Warning: this project will use `xc7a100tcsg324-1` (for HUST) as your board. Please fork and modify template if you'd like to use other board. We can easily support changing board by Vivadofile, if you can solve the TODO in ./vivado-wrapper:line5.

```sh
cd vivado-wrapper/example
vivadow build
Expand Down

0 comments on commit caa5638

Please sign in to comment.