Skip to content

Commit

Permalink
Renamed ./doc as ./docs
Browse files Browse the repository at this point in the history
To allow automatic building of GH page on github.io
  • Loading branch information
jserot committed Nov 14, 2023
1 parent c492954 commit e2b8142
Show file tree
Hide file tree
Showing 556 changed files with 7,064 additions and 22 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ config
config-stamp
*.dvi
*.pdf
doc/user_manual/*
!doc/user_manual/rfsm_um.pdf
doc/ref_manual/*
!doc/ref_manual/rfsm_rm.pdf
docs/user_manual/*
!docs/user_manual/rfsm_um.pdf
docs/ref_manual/*
!docs/ref_manual/rfsm_rm.pdf
*.aux
*.log
*.rel
Expand Down
13 changes: 3 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.PHONY: doc.html doc.pdf tests

all: host std_guest doc

host:
Expand All @@ -16,23 +14,18 @@ other_guests:
install:
dune build @install

INSTALL_DOCDIR=`opam var doc`

doc: doc.html doc.pdf

doc.view:
open -a Safari _build/default/_doc/_html/index.html

doc.html:
dune build @doc
cp -r _build/default/_doc/_html/* ./docs

doc.pdf:
(cd ./doc/user_manual; make)
(cd ./doc/ref_manual; make)

html: README.md
pandoc -t html -o README.html README.md
pandoc -t html -o CHANGES.html CHANGES.md
(cd ./docs/user_manual; make)
(cd ./docs/ref_manual; make)

clean:
dune clean
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ two inputs (`h`, of type `event`, and `e`, of type `bool`) and one output (`s`,
occurrence of the `h` event and when a `1` is read, the `s` output is set to `1` for a duration
`D=n.T`.

![](https://github.com/jserot/rfsm/blob/master/doc/figs/gensig-model-moore.png "")
![](https://github.com/jserot/rfsm/blob/master/docs/figs/gensig-model-moore.png "")

The model has two states (named `E0` and `E1`). The initial state is `E0`.
The `s` output is `0` when the machine is in state `E0` and `1` when it is in state `E1`.
Expand Down Expand Up @@ -75,12 +75,12 @@ Invoking the `rfmsc` compiler with the `-sim` option produces `.vcd` file, which
be viewed with the [Gtkwave](http://gtkwave.sourceforge.net) trace viewer for example, as shown
below

![](https://github.com/jserot/rfsm/blob/master/doc/figs/gensig-chrono.png "")
![](https://github.com/jserot/rfsm/blob/master/docs/figs/gensig-chrono.png "")

Invoking the `rfmsc` compiler with the `-ctask`, `-systemc` and `-vhdl` option can generate C,
SystemC and VHDL code for the model (and the testbench). Here's for example the VHDL code generated
for the `gensig` model. All the generated code can can be viewed
[here](https://github.com/jserot/rfsm/tree/master/doc/code/gensig).
[here](https://github.com/jserot/rfsm/tree/master/docs/code/gensig).

RFSM can also be used to describe multi-FSM models. Here's a description of a simple modulo-8
counter as three concurrent modulo-2 counters :
Expand Down Expand Up @@ -116,11 +116,11 @@ internal, shared events named `R0` and `R1`.
A graphical view of global model (obtained by invoking the `rfsmc` compiler with the `-dot` option) is
given below

![](https://github.com/jserot/rfsm/blob/master/doc/figs/ctrmod8-top.png "")
![](https://github.com/jserot/rfsm/blob/master/docs/figs/ctrmod8-top.png "")

Simulation of this model produces the following trace :

![](https://github.com/jserot/rfsm/blob/master/doc/figs/ctrmod8-chrono.png "")
![](https://github.com/jserot/rfsm/blob/master/docs/figs/ctrmod8-chrono.png "")

## PACKAGE DESCRIPTION

Expand Down Expand Up @@ -151,11 +151,11 @@ for simulation or implementation on a target platform (micro-controlers or FPGAs
## Documentation

The user and reference manuals can be found
[here](https://github.com/jserot/rfsm/tree/master/doc/user_manual/rfsm_um.pdf) and
[here](https://github.com/jserot/rfsm/tree/master/doc/ref_manual/rfsm_rm.pdf).
[here](https://github.com/jserot/rfsm/tree/master/docs/user_manual/rfsm_um.pdf) and
[here](https://github.com/jserot/rfsm/tree/master/docs/ref_manual/rfsm_rm.pdf).

The "host" library API is documented
[here](https://github.com/jserot/rfsm/blob/master/doc/lib/index.html "").
[here](https://jserot/github.io/rfsm/index.html "").



Expand Down
Binary file added docs/_odoc_support/fonts/KaTeX_AMS-Regular.woff2
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/_odoc_support/fonts/KaTeX_Fraktur-Bold.woff2
Binary file not shown.
Binary file not shown.
Binary file added docs/_odoc_support/fonts/KaTeX_Main-Bold.woff2
Binary file not shown.
Binary file not shown.
Binary file added docs/_odoc_support/fonts/KaTeX_Main-Italic.woff2
Binary file not shown.
Binary file added docs/_odoc_support/fonts/KaTeX_Main-Regular.woff2
Binary file not shown.
Binary file not shown.
Binary file added docs/_odoc_support/fonts/KaTeX_Math-Italic.woff2
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
461 changes: 461 additions & 0 deletions docs/_odoc_support/highlight.pack.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/_odoc_support/katex.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/_odoc_support/katex.min.js

Large diffs are not rendered by default.

Loading

0 comments on commit e2b8142

Please sign in to comment.