diff --git a/docs/resources/images/Mac OS Drivers flowchart for iceprog.odg b/docs/resources/images/Mac OS Drivers flowchart for iceprog.odg deleted file mode 100644 index 17a2dffb..00000000 Binary files a/docs/resources/images/Mac OS Drivers flowchart for iceprog.odg and /dev/null differ diff --git a/docs/resources/images/apio-cheat-sheet.png b/docs/resources/images/apio-cheat-sheet.png deleted file mode 100644 index 53ac3729..00000000 Binary files a/docs/resources/images/apio-cheat-sheet.png and /dev/null differ diff --git a/docs/resources/images/apio-cheat-sheet.svg b/docs/resources/images/apio-cheat-sheet.svg deleted file mode 100644 index 68534f72..00000000 --- a/docs/resources/images/apio-cheat-sheet.svg +++ /dev/null @@ -1,600 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - driversinitinstalluninstall - boardsconfigexamplesrawsystemupgrade - Cat-boardTinyFPGA-B2TinyFPGA-BXalhambra-iiblackiceblackice-iifpga101go-boardiCE40-HX8KiCE40-UP5KiCEBreakeriCEBreaker-bitsyiceblick40-hx1kicestickicezumicoboardkefirupduinoupduino2 - apio install --allapio drivers --X-enableapio init -b BOARDapio buildapio upload - pip install apio - version 0.4 - - setup commands - - project commands - - supported boards - - utility commands - - quick start - apio cheat sheet - - - buildcleantimeupload - lintsimverify - synthesis - simulation - - - - diff --git a/docs/resources/images/macos-drivers-flowchart.png b/docs/resources/images/macos-drivers-flowchart.png deleted file mode 100644 index d9b9678a..00000000 Binary files a/docs/resources/images/macos-drivers-flowchart.png and /dev/null differ diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst deleted file mode 100644 index 8ecefb67..00000000 --- a/docs/source/quick_start.rst +++ /dev/null @@ -1,127 +0,0 @@ -.. quick_start - -Quick Start -=========== - -Once apio has been installed and the drivers have been correctly configured is time to start playing with your FPGA! - -Install packages ----------------- - -.. code:: - - $ apio install --all - -Create a project ----------------- - -Go to your project's directory or try the examples - -.. code:: - - $ apio examples -d leds - $ cd leds - -Configure your board -~~~~~~~~~~~~~~~~~~~~ - -Find your board in the list - -.. code:: - - $ apio boards --list - - Supported boards: - - ---------------------------------------------------------- - Board FPGA Type Size Pack - ---------------------------------------------------------- - Alchitry-Cu iCE40-HX8K-CB132 hx 8k cb132 - Cat-board iCE40-HX8K-CT256 hx 8k ct256 - TinyFPGA-B2 iCE40-LP8K-CM81 lp 8k cm81 - TinyFPGA-BX iCE40-LP8K-CM81 lp 8k cm81 - alhambra-ii iCE40-HX4K-TQ144 hx 8k tq144:4k - blackice iCE40-HX4K-TQ144 hx 8k tq144:4k - blackice-ii iCE40-HX4K-TQ144 hx 8k tq144:4k - fomu iCE40-UP5K-UWG30 up 5k uwg30 - fpga101 iCE40-UP5K-SG48 up 5k sg48 - go-board iCE40-HX1K-VQ100 hx 1k vq100 - iCE40-HX8K iCE40-HX8K-CT256 hx 8k ct256 - iCE40-UP5K iCE40-UP5K-SG48 up 5k sg48 - iCEBreaker iCE40-UP5K-SG48 up 5k sg48 - iCEBreaker-bitsy iCE40-UP5K-SG48 up 5k sg48 - iceblink40-hx1k iCE40-HX1K-VQ100 hx 1k vq100 - icestick iCE40-HX1K-TQ144 hx 1k tq144 - icezum iCE40-HX1K-TQ144 hx 1k tq144 - icoboard iCE40-HX8K-CT256 hx 8k ct256 - kefir iCE40-HX4K-TQ144 hx 8k tq144:4k - upduino iCE40-UP5K-SG48 up 5k sg48 - upduino2 iCE40-UP5K-SG48 up 5k sg48 - -Create an apio.ini file with your board - -.. code:: - - $ apio init --board icestick - -Process the project -------------------- - -Verify -~~~~~~ - -Check your verilog code using `Icarus Verilog `_ - -.. code:: - - $ apio verify - - -Simulate -~~~~~~~~ - -Simulate your test bench using `Icarus Verilog `_ and `GTKWave `_ - -.. code:: - - $ apio sim - -.. image:: ../resources/images/gtkwave-simulation.png - -.. note:: - - GTKWave must be installed. - - +---------+-------------------------+ - | Debian | apt-get install gtkwave | - +---------+-------------------------+ - | Mac OSX | brew install gtkwave | - +---------+-------------------------+ - | Windows | apio install gtkwave | - +---------+-------------------------+ - -Build -~~~~~~ - -Syntesize your project using `Icestorm Tools `_ - -.. code:: - - $ apio build - - -Upload -~~~~~~ - -Connect your FPGA board and upload the bitstream using `Icestorm Tools `_ - -.. code:: - - $ apio upload - - -All the leds should turn on after 3 seconds - -.. image:: ../resources/images/apio-icestorm-hello-world.png - -**Congrats! Now You have your fully open source FPGA toolchain ready!**