documentation

pull/1/head
panhongyang 2023-02-06 13:29:42 +08:00
parent 89137f5077
commit d724f7eea6
22 changed files with 60 additions and 5 deletions

View File

@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = OUTPUT_DIRECTORY = doxyxml
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and

0
docs/balance.rst Normal file
View File

0
docs/cec.rst Normal file
View File

25
docs/changelog.rst Normal file
View File

@ -0,0 +1,25 @@
Change Log
==========
Next release
------------
v1.0 (December 20, 2022)
------------------------
* Initial release
* Data structures ``aiger``, ``load``, ``bench``, ``verilog``, ``blif``
* Logic synthesis commands ``balance``
* Logic synthesis commands ``resub``
* Logic resynthesis commands ``resyn``
* Logic synthesis commands ``rewrite``
* Logic synthesis commands ``reduction``
* Logic synthesis commands ``refactor``
* Compute truth table for expression ``exprsim``
* Combinational equivalence checking for AIG network ``cec``
* SAT solver ``sat``
* Logic network simulation ``sim``
* FPGA technology mapping of the network ``lutmap``
* Standard cell mapping ``techmap``

0
docs/create_graph.rst Normal file
View File

View File

@ -2,7 +2,7 @@ Examples
============ ============
All commands All commands
---------------------------------- ----------------
Input: Input:
:: ::
@ -34,7 +34,7 @@ Output:
For more details, simply add '-h' after command to see all options of this command. For more details, simply add '-h' after command to see all options of this command.
Synthesis of EPFL benchmarks Synthesis of EPFL benchmarks
---------------------------------- ----------------
In the following example, we show how `phyLS` can be used to synthesize a EPFL benchamrk. In the following example, we show how `phyLS` can be used to synthesize a EPFL benchamrk.

0
docs/exprsim.rst Normal file
View File

View File

@ -3,10 +3,39 @@ Welcome to phyLS's documentation!
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents
introduction introduction
installation installation
changelog
examples examples
acknowledgments acknowledgments
.. toctree::
:maxdepth: 2
:caption: Reference
load
read
write
balance
create_graph
reduction
refactor
resub
resyn
rewrite
lut_mapping
lutmap
techmap
cec
exprsim
sat
sim
Indices and tables
==================
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`

0
docs/load.rst Normal file
View File

0
docs/lut_mapping.rst Normal file
View File

0
docs/lutmap.rst Normal file
View File

0
docs/read.rst Normal file
View File

0
docs/reduction.rst Normal file
View File

0
docs/refactor.rst Normal file
View File

View File

@ -1 +1,2 @@
breathe sphinx==4.0.2
breathe==4.30.0

0
docs/resub.rst Normal file
View File

0
docs/resyn.rst Normal file
View File

0
docs/rewrite.rst Normal file
View File

0
docs/sat.rst Normal file
View File

0
docs/sim.rst Normal file
View File

0
docs/techmap.rst Normal file
View File

0
docs/write.rst Normal file
View File