Commit Graph

28 Commits

Author SHA1 Message Date
Alessandro Comodi d0ab539f25 fixing documentation cross-reference links
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 15:44:45 +02:00
Felix Held b6c476167a README.md: clarify to not manually source the Vivado environment
Signed-off-by: Felix Held <felix-github@felixheld.de>
2019-04-05 21:05:27 +02:00
Tim 'mithro' Ansell dd368638bd Adding some build badges to README.md
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-03-20 16:59:27 -07:00
Tim 'mithro' Ansell ac8f228ac1 Small fix to README in license section.
Fixes #643.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-02-27 07:01:23 -08:00
Tim 'mithro' Ansell f98dad14ed Update README for settings move.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-12-31 10:30:36 +01:00
Oguz Meteer 832585bfea Remove unnecessary warning from README.md
Signed-off-by: Oguz Meteer <info@guztech.nl>
2018-12-31 10:19:33 +01:00
Oguz Meteer 019492c10d Update README.md
Rearrange steps to make sure the user always downloads a stable
pre-generated database or builds everything, before working on
fuzzers.

Signed-off-by: Oguz Meteer <info@guztech.nl>
2018-12-30 12:00:16 +01:00
Oguz Meteer 6d6da3b6d1 Update README.md with individual steps and how to fix pyjson5 on Arch
Signed-off-by: Oguz Meteer <info@guztech.nl>
2018-12-29 19:30:34 +01:00
John McMaster 26b799efc3 README: source after virtualenv
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-12-29 16:03:34 +01:00
John McMaster e449dc3e38 README: misc cleanup
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-12-29 15:14:23 +01:00
Felix Held 0d6e327229 introduce vivado wrapper
This fixes the problem that when sourcing the vivado settings file the
library search path is modified resulting in non-vivado binaries not working
due to being dynamically linked against the vivado libraries instead of the
system ones.

Signed-off-by: Felix Held <felix-github@felixheld.de>
2018-12-28 19:05:49 +01:00
rapha 34e741ec79 added sudo to readme
Signed-off-by: rapha <raphbeutel@gmail.com>
2018-12-27 17:35:40 +01:00
Tim 'mithro' Ansell c04ca0dc36 Adding better instructions for Python to README.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-12-17 18:54:17 -08:00
John McMaster 1023379f10 readme: add pip note
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-11-13 14:05:18 -08:00
Sarah Maddox 6dc15342df First commit of docs guide.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-05-07 10:49:46 +10:00
Sarah Maddox 3d5b3c5525 Added info on signoff via commit statement.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-23 11:03:22 +10:00
Davide cd1bbc75e7 Added Link to make readthedocs Documentation Webpage easier to find by putting it into the main README file
Signed-off-by: Davide <davide.toldo@stud.tu-darmstadt.de>
2018-02-20 00:46:07 +01:00
Rick Altherr 02d28f2920 Document how to enable test and build with debug info
Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
2018-01-12 11:48:11 -08:00
Clifford Wolf a80b80c63d Fixes in fuzzers top-level Makefile, Update README
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-01-05 22:16:12 +01:00
John McMaster bcba8197f2 Document MUXF8 Vivado compatibility issue
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2017-12-22 15:52:40 -08:00
Tim 'mithro' Ansell 29d343a293 Make download-latest-db use https by default.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2017-12-21 11:19:43 +01:00
Tim 'mithro' Ansell c237bcd412 Adding top level docs.
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 23:28:27 +01:00
Clifford Wolf a9f35e3e0c Fix formatting in README.md
Signed-off-by: Clifford Wolf <clifford@clifford.at>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:39 +01:00
Clifford Wolf 16c61bb951 Fix typo in README.md
Signed-off-by: Clifford Wolf <clifford@clifford.at>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:39 +01:00
Rick Altherr c734fff44b README: clarify cmake package requirements
CMake 3.5.0 or later is required.  For Ubuntu 14.04, that has a
different package name.

Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:39 +01:00
Clifford Wolf ef60d2d1f0 Update README
Signed-off-by: Clifford Wolf <clifford@clifford.at>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:39 +01:00
Rick Altherr ef411c4eaf README: instructions for building C++ tools
Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:39 +01:00
Clifford Wolf b800d548eb Create README.md
Signed-off-by: Clifford Wolf <clifford@clifford.at>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:30 +01:00