Skip to content

Commit 95afdae

Browse files
committed
docs: add content to 'Extending'
1 parent 45995b8 commit 95afdae

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/extending.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
11
Extending
22
=========
3+
4+
1. Add support for the new tool:
5+
6+
.. code-block:: python
7+
8+
pyfpga/templates/<NEWTOOL>.jinja
9+
pyfpga/templates/<NEWTOOL>-prog.jinja
10+
pyfpga/<NEWTOOL>.py
11+
12+
2. Include the new tool on Factory:
13+
14+
.. code-block:: python
15+
16+
pyfpga/factory.py
17+
18+
3. Add tests and a tool mock-up:
19+
20+
.. code-block:: python
21+
22+
tests/test_tools.py
23+
tests/mocks/<NEWTOOL_EXECUTABLE>
24+
25+
4. Updated the project's documentation:
26+
27+
.. code-block:: python
28+
29+
README.md
30+
docs
31+
32+
5. [OPTIONAL] Add examples:
33+
34+
.. code-block:: python
35+
36+
examples/sources/cons/<NEWBOARD>/timing.<EXT>
37+
examples/sources/cons/<NEWBOARD>/clk.<EXT>
38+
examples/sources/cons/<NEWBOARD>/led.<EXT>
39+
examples/projects/<NEWTOOL>.py
40+
examples/hooks/<NEWTOOL>.py

0 commit comments

Comments
 (0)