Commit Graph

139 Commits

Author SHA1 Message Date
Unai Martinez-Corral 7cb37167a5 doc/getting: convert last section into an admonition
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-22 22:44:17 +01:00
Unai Martinez-Corral 7c130a24d3 docs/index: use multiple toctrees with different captions
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-22 22:44:17 +01:00
Unai Martinez-Corral 58f4791711 docs: s/SymbiFlow/F4PGA/
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-21 20:08:07 +01:00
Unai Martinez-Corral 289f92c004 docs: use extlinks instead of raw refs
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-21 20:08:07 +01:00
Unai Martinez-Corral 8ad41a5be3 docs/conf: use extension InterSphinx
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-21 20:08:07 +01:00
Unai Martinez-Corral 3b6dbc5278 docs/conf: use extension ExtLinks 2022-02-21 20:08:07 +01:00
Unai Martinez-Corral d2dc70bb6a docs: add logo and favicon; use '_static'
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-21 16:40:48 +01:00
Karol Gugala 241e4e426e Docs: fix colors
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2022-02-18 18:53:12 +01:00
Karol Gugala 091debb4de docs: use chips theme
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2022-02-18 18:44:39 +01:00
Karol Gugala d586f4a394 Docs: fix getting link
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2022-02-18 18:38:19 +01:00
Karol Gugala f0c5adcb75 Raname to F4PGA
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2022-02-18 18:15:44 +01:00
Karol Gugala 12da97d733 Relicense to Apache-2.0
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2022-02-02 19:41:06 +01:00
Alessandro Comodi 8d9b042c7b xc7: bump packages
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2022-02-01 14:04:19 +01:00
umarcor 04ea62797b docs: add prerequisites on Fedora
Signed-off-by: umarcor <unai.martinezcorral@ehu.eus>
2021-12-15 20:34:45 +01:00
Tomasz Michalak e4e1532957
Merge pull request #184 from antmicro/improve-docs
docs: added note on env preparation
2021-12-07 22:23:18 +01:00
Alessandro Comodi 1081a8409d update symbiflow packages
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-11-17 13:31:59 +01:00
Joshua Fife 4a818ebf9a fixed documentation and makefiles. Renamed common makefile.
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-11-11 13:47:47 -07:00
Joshua Fife 6947f53eb7 finished updating makefile instructions and modified makeifle names
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-11-11 13:47:47 -07:00
Tim Ansell 52e9db39b4
Merge pull request #210 from antmicro/symbiflow-theme
Switch to sphinx_symbiflow_theme
2021-11-02 13:40:23 -07:00
Karol Gugala a7e0a66dcf Switch to correct SymbiFlow theme
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2021-11-02 16:18:39 +01:00
Karol Gugala 56ba7c6670 Add github_url
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2021-11-02 15:53:18 +01:00
Karol Gugala 0ea6ba72cf Fix docs build warnings
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2021-11-02 15:19:17 +01:00
Karol Gugala c9ff26a6ef Switch to sphinx_symbiflow_theme
Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2021-11-02 15:10:50 +01:00
Alan Green d2a1004cd4 getting-symbiflow.rst: Clarified download location
Clarifies that the conda_installer.sh script should be downloaded into
the git repository.

By habit, I place downloaded scripts into the ~/Downloads directory, and
avoid adding non-repo files to repositories. However, when I did that I
ended up with some difficult to diagnose bugs several steps later. It
was only on carefully rereading the instructions I realized what I ought
to have done. The intention of this change is to make clear to other new
users that they ought to place conda_installer.sh into the git repo
directory.

Signed-off-by: Alan Green <alan.green@gmail.com>
2021-10-21 09:03:20 +11:00
Joshua Fife a74f616bbf Put projf in third_party and fixed makefiles
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-10-12 21:56:47 -06:00
Joshua Fife 63b5054432 fixed CI and spacing
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-10-09 12:27:45 -06:00
Joshua Fife 15e85e390c Created documentation and makefiles added proj-f to CI
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-10-09 12:26:59 -06:00
Alessandro Comodi 1ddf55785d docs: added note on env preparation
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-09-27 10:24:29 +02:00
WhiteNinjaZ 9e2727c193
Merge branch 'SymbiFlow:master' into watch-pwm 2021-09-09 00:01:10 -06:00
Alessandro Comodi df825b6e32 xc7: update packages
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-08-23 09:54:49 +02:00
Joshua Fife f41e99f832 rebased onto main
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-08-20 14:05:28 -06:00
Joshua Fife 977fc93ba8 Modified Makefiles to call common/Makefile
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-08-20 13:12:58 -06:00
Joshua Fife a827cf28d8 seperated pwm and timer from other designs
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-08-20 13:06:18 -06:00
WhiteNinjaZ af646ee6f1
Merge branch 'SymbiFlow:master' into button_controll 2021-08-17 15:43:01 -06:00
WhiteNinjaZ 0cf7b1c73f
Merge branch 'SymbiFlow:master' into watch-pwm 2021-08-17 13:10:31 -06:00
Alessandro Comodi b9eaf29529 xc7: update symbiflow packages
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-08-17 11:38:28 +02:00
Joshua Fife bc032841d2 Fixed long lines for title headings
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-29 20:50:41 -06:00
Joshua Fife 189d6a746e seperated button_control
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-23 18:09:07 -06:00
Joshua Fife 3604dc27ea Fixed documentation error
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-23 17:53:18 -06:00
Joshua Fife 2293398577 seperated pwm and timer from other designs
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-23 17:35:41 -06:00
Joshua Fife 7f2fc9b0c1 added designs into tuttest
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-22 12:29:30 -06:00
Joshua Fife 77fc6d315e fixed image file paths and a few fixes to readmes
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-21 17:06:48 -06:00
Joshua Fife b03b3292d3 Touched up all documentation and updated videos
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-21 15:27:24 -06:00
Joshua Fife bbffe02635 Added all videos, fixed some bugs, and changed names
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-21 15:27:24 -06:00
Joshua Fife 96bbace913 Added completed pwm and stop watch examples. Partially complete debouncer and uart_tx
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-21 15:27:08 -06:00
Joshua Fife 23ef2d56a2 Fixed a few grammar errors and made things a little clearer
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-05 16:37:40 -06:00
Joshua Fife ce5b57240d Fixed several minor errors and made documentation more concise
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-05 14:54:44 -06:00
Joshua Fife bcdc18dc06 Made spacing consistent both in documentation and Makefiles
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-05 11:52:12 -06:00
Joshua Fife 0ee344cf6b added code links and fixed minor errors
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-05 11:35:04 -06:00
WhiteNinjaZ 5d19b00176
Merge branch 'SymbiFlow:master' into master 2021-07-02 16:18:06 -06:00
Joshua Fife d5c2ee1938 Resolved minor errors and added instructions for constraints
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-02 15:50:12 -06:00
Joshua Fife 62850aaa99 Added explanation of symbiflow commands
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-07-02 12:08:32 -06:00
Alessandro Comodi 2dbe7e8b5a build-examples: fix conda-prep-env instructions
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-07-02 13:17:05 +02:00
Alessandro Comodi a5837bb0ba eos-s3: update environment, requirements and toolchain
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-07-02 12:51:20 +02:00
Joshua Fife b8a300db26 Changed some formatting, made naming consistent, and clarified info on SystemVerilog
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-30 09:21:21 -06:00
Joshua Fife 649a694960 Fixed merge conflict
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-26 18:43:21 -06:00
Joshua Fife c3f494d7fc Made instructions clearer and added some information on the ifeq/else ifeq blocks
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-25 18:26:22 -06:00
Joshua Fife f3115cbe40 Changes rough draft
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-25 16:23:44 -06:00
Joshua Fife 2111fcc323 few makefile instruction changes
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-25 12:12:23 -06:00
Brent Nelson eb06e989ea Made two minor text edits.
Signed-off-by: Brent Nelson <nelson@ee.byu.edu>
2021-06-23 13:54:10 -06:00
Brent Nelson ddb9fe4b42 Added term symbiflow-examples in place of symbiflow in a couple of places
Signed-off-by: Brent Nelson <nelson@ee.byu.edu>
2021-06-23 13:51:42 -06:00
Brent Nelson a8590f707e Added links to new pages on main index page
Signed-off-by: Brent Nelson <nelson@ee.byu.edu>
2021-06-23 13:33:17 -06:00
Joshua Fife 46a7ce1fc7 Revised draft for Personal Designs
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-19 19:40:16 -06:00
Filip Kokosinski 63d392b21c xc7: add picorv32 and vexriscv litex example
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-06-18 09:31:25 +02:00
Joshua Fife c451dae1ac Added extra XDC PCF SDC info
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-15 17:16:03 -06:00
Joshua Fife b6932ed300 Rough Makefile Instructions
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-08 20:48:25 -06:00
Joshua Fife 1cafeeff8d Added instructions for Makefile
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-08 17:59:33 -06:00
Joshua Fife 52ba45644e Rough Draft
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-08 12:42:12 -06:00
Joshua Fife fa8c64a13a A few minor clarifications on running examples (modified to include textual instructions)
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-01 16:20:57 -06:00
Joshua Fife 927379d5a3 A few minor clarifications on running examples
Signed-off-by: Joshua Fife <jpfife17@gmail.com>
2021-06-01 16:20:28 -06:00
Ryan Johnson 9b953d9f75 formatted files
Signed-off-by: Ryan Johnson <ryancj14@gmail.com>
2021-05-13 12:07:40 -06:00
Ryan Johnson 0da09dafff changes after initial review
Signed-off-by: Ryan Johnson <ryancj14@gmail.com>
2021-05-13 12:07:04 -06:00
Ryan Johnson a166626b25 Initial changes to implement formatters
Signed-off-by: Ryan Johnson <ryancj14@gmail.com>
2021-05-13 12:06:49 -06:00
Chandler Jearls d2b0747fbe fixed a small typo in collect_readmes.py
Signed-off-by: Chandler Jearls <cjearls@vt.edu>
2021-04-21 17:52:09 +00:00
Chandler Jearls 8c67e280e1 added Nexys4DDR to the documentation
Signed-off-by: Chandler Jearls <cjearls@vt.edu>
2021-04-21 17:48:13 +00:00
Alessandro Comodi cdb36f5489 xc7: update packages
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-03-26 14:52:22 +01:00
Karol Gugala dce2d6859b
Merge pull request #116 from duck2/master
Fix typos
2021-01-23 14:44:12 +01:00
Alessandro Comodi 98f452d601 xc7: install: add xc7_200t
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-01-17 22:08:58 +01:00
Robert Winkler 14e8de92c7 readme: Add a200T package installation
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>

readme: Add instructions for counter on Nexys Video

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>

xc: Add counter example for Nexys Video

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2021-01-17 22:08:58 +01:00
Fahrican Koşar a32acf7ea8 fix typos
Signed-off-by: Fahrican Koşar <duck2@protonmail.com>
2021-01-09 20:09:46 +00:00
Alessandro Comodi 1dd36fe587 zynq: add counter docs addition and zynq programming
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2020-12-18 12:14:42 +01:00
Filip Kokosinski 2281887c9f docs: handle strong and reference inline blocks
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2020-12-17 12:24:09 +01:00
Robert Winkler aec4fe1cf1 ci: Add debian buster and debian bullseye
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-15 12:49:44 +01:00
Robert Winkler e3b82cf3b7 Add license headers to docs and CI scripts
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-14 14:45:55 +01:00
Robert Winkler 613b8eabad docs: Move example collection code to separate file
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-14 14:45:55 +01:00
Robert Winkler 29ba427094 docs: Update description
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-14 14:45:55 +01:00
Robert Winkler fd559b5ce4 docs: Update prerequisites
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-14 14:45:55 +01:00
Robert Winkler f579ebfb8d ci: Extract tuttest runs from docker
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-14 14:45:55 +01:00
Filip Kokosinski 2ddee57006 docs: Initial Sphinx setup
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2020-12-11 10:34:04 +01:00