Skip to content

Commit abcc851

Browse files
committed
Update README and convert to markdown.
1 parent d9abcfc commit abcc851

File tree

2 files changed

+69
-49
lines changed

2 files changed

+69
-49
lines changed

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Introduction
2+
============
3+
The Verilog-to-Routing (VTR) project is a world-wide collaborative effort to provide a open-source framework for conducting FPGA architecture and CAD research and development. The VTR design flow takes as input a Verilog description of a digital circuit, and a description of the target FPGA architecture. It then perfoms:
4+
* Elaboration & Synthesis (ODIN II)
5+
* Logic Optimization & Technology Mapping (ABC)
6+
* Packing, Placement, Routing & Timing Analysis (VPR)
7+
8+
to generate FPGA speed and area results.
9+
VTR also includes a set of benchmark designs which are known to work with the flow to get you going.
10+
11+
From more information please see the [wiki](https://github.com/verilog-to-routing/vtr-verilog-to-routing/wiki).
12+
13+
Download
14+
========
15+
For most users of VTR (rather than active developers) you should download the latest packaged (and regression tested) version of VTR from [here](https://github.com/verilog-to-routing/vtr-verilog-to-routing/wiki).
16+
17+
Mailing Lists
18+
=============
19+
If you have questions, or want to keep up-to-date with VTR, consider joining our mailing lists:
20+
[VTR-Announce](https://groups.google.com/forum/#!forum/vtr-announce): VTR release announcements (low traffic)
21+
[VTR-Users](https://groups.google.com/forum/#!forum/vtr-users): Discussions about using VTR
22+
[VTR-Devel](https://groups.google.com/forum/#!forum/vtr-devel): Discussions about VTR development
23+
[VTR-Commits](https://groups.google.com/forum/#!forum/vtr-commits): VTR revision control commits
24+
25+
How to Cite
26+
===========
27+
The following paper may be used as a general citation for VTR:
28+
29+
J. Luu, J. Goeders, M. Wainberg, A. Somerville, T. Yu, K. Nasartschuk, M. Nasr, S. Wang, T. Liu, N. Ahmed, K. B. Kent, J. Anderson, J. Rose and V. Betz "VTR 7.0: Next Generation Architecture and CAD System for FPGAs," ACM TRETS, Vol. 7, No. 2, June 2014, pp. 6:1 - 6:30.
30+
31+
Bibtex:
32+
```
33+
@article{vtr2014,
34+
title={{VTR 7.0: Next Generation Architecture and CAD System for FPGAs}},
35+
author={Luu, Jason and Goeders, Jeff and Wainberg, Michael and Somerville, Andrew and Yu, Thien and Nasartschuk, Konstantin and Nasr, Miad and Wang, Sen and Liu, Tim and Ahmed, Norrudin and Kent, Kenneth B. and Anderson, Jason and Rose, Jonathan and Betz, Vaughn},
36+
journal = {ACM Trans. Reconfigurable Technol. Syst.},
37+
month={June},
38+
volume={7},
39+
number={2},
40+
pages={6:1--6:30},
41+
year={2014}
42+
}
43+
```
44+
45+
Development
46+
===========
47+
This is the development trunk for the Verilog-to-Routing project. Unlike the nicely packaged releases that we create, you are working with code in a constant state of flux. You should expect that the tools are not always stable and that more work is needed to get the flow to run.
48+
49+
For new developers, please do the tutorial in `tutorial/NewDeveloperTutorial.txt`. You will be directed back here once you ramp up.
50+
51+
VTR development follows a classic centralized repository (svn-like) workflow. The 'master' branch is supposed to be the most current stable version of the project. Developers checkout a local copy of the code at the start of development, then do regular updates (e.g. `git pull`) to keep in sync with the GitHub master. When a developer has a tested, working change to put back into the trunk, he/she performs a `git push` operation. Unstable code should remain in the developer's local copy.
52+
53+
We do automated testing of the trunk using BuildBot to verify functionality and Quality of Results (QoR).
54+
You can see the state of the trunk [here](http://islanders.eecg.utoronto.ca:8080/waterfall).
55+
QoR tracking links can be found [here](http://islanders.eecg.utoronto.ca:8080/).
56+
57+
*IMPORTANT*: A broken build must be fixed at top priority. You break the build if your commit breaks any of the automated regression tests.
58+
59+
Contributors
60+
============
61+
*Please keep this up-to-date*
62+
63+
Professors: Kenneth Kent, Vaughn Betz, Jonathan Rose, Jason Anderson, Peter Jamieson
64+
65+
Graduate Students: Kevin Murray, Jason Luu, Oleg Petelin, Jeffrey Goeders, Chi Wai Yu, Andrew Somerville, Ian Kuon, Alexander Marquardt, Andy Ye, Wei Mark Fang, Tim Liu, Charles Chiasson
66+
67+
Summer Students: Opal Densmore, Ted Campbell, Cong Wang, Peter Milankov, Scott Whitty, Michael Wainberg, Suya Liu, Miad Nasr, Nooruddin Ahmed, Thien Yu, Long Yu Wang, Matthew J.P. Walker, Amer Hesson, Sheng Zhong, Hanqing Zeng
68+
69+
Companies: Altera Corporation, Texas Instruments

README.txt

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)