Skip to content

Commit 2393e44

Browse files
committed
docs edits
1 parent 506812c commit 2393e44

4 files changed

Lines changed: 7 additions & 12 deletions

File tree

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,9 @@ For more details, see pymwp [documentation](https://statycc.github.io/pymwp/), p
4949
## Documentation and Demo
5050

5151
* **Documentation:** [statycc.github.io/pymwp](https://statycc.github.io/pymwp/)
52-
52+
* **Manual**: [Tool user guide](https://statycc.github.io/.github/pymwp) with detailed examples and discussion.
5353
* **Demo**: [online demo](https://statycc.github.io/pymwp/demo/) and [input examples](https://statycc.github.io/pymwp/examples/)
5454

55-
* **Publication**: ["pymwp: A Static Analyzer Determining Polynomial Growth Bounds"](http://doi.org/10.1007/978-3-031-45332-8_14),
56-
also on [HAL](https://hal.science/hal-03269121v4/document).
57-
58-
* **Tool user guide**: [statycc.github.io/.github/pymwp](https://statycc.github.io/.github/pymwp) with detailed examples and discussion.
59-
6055
The user guide is the ideal place to start for a general and interactive introduction to pymwp.
6156

6257
## Installation

docs/modules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Technical Introduction
1+
# Modules Introduction
22

3-
At a high-level, pymwp reads a C file and produces an analysis result.
3+
pymwp works by reading a C file and producing an analysis result.
44

55
![pymwp workflow](assets/workflow.png){ width="700" }
66
/// caption
77
Fig. 1: pymwp workflow
88
///
99

10-
Under the hood, pymwp is built from various modules.
10+
Internally, pymwp is built from various modules.
1111
Each module has a specific role.
1212
For example, `Analysis` runs program analysis (i.e., the intermediate steps between parser and output in Fig. 1);
1313
the `matrix` module contains matrix utilities, the `parser` is the front-end, etc.

docs/publications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Preferred Citation Format
44

5-
To reference pymwp, use:
5+
Refer to ["pymwp: A Static Analyzer Determining Polynomial Growth Bounds"](http://doi.org/10.1007/978-3-031-45332-8_14).
66

77
``` bibtex
88
@inproceedings{aubert2023,
@@ -19,7 +19,7 @@ To reference pymwp, use:
1919
}
2020
```
2121

22-
The article is available without paywall [here](https://nkrusch.github.io/files/pymwp.pdf).
22+
The article is also available on [HAL](https://hal.science/hal-03269121v4/document).
2323

2424

2525
## Published Works

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav:
1414
- Demo: demo.md
1515
- Publications: publications.md
1616
- Modules:
17-
- Technical Intro: modules.md
17+
- Introduction: modules.md
1818
- Analysis: analysis.md
1919
- Bound: bound.md
2020
- Choice: choice.md

0 commit comments

Comments
 (0)