fix several issues in Docs

whitemech · Feb 28, 2020 · 8adf54e · 8adf54e
1 parent ea102dc
commit 8adf54e
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 21 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,14 +1,10 @@
 # Release History
 
-## 0.1.0 (2019-04-13)
-
-* Basic support for DFAs and NFAs.
-* Algorithms for DFA minimization and trimming.
-* Algorithm for NFA determinization.
-
-## 0.2.0 (2019-09-30)
+## 0.3.1 (2020-02-28)
 
-* Refactoring of the repository
+* Improved CI: using GitHub actions instead of Travis.
+* Included many other checks: `safety`, `black`, `liccheck`.
+* Improved documentation.
 
 ## 0.3.0 (2020-02-09)
 
@@ -18,8 +14,12 @@
 * Introduced `SymbolicAutomaton` and `SymbolicDFA`, where the guards
   on transitions are propositoinal formulas.
 
-## 0.3.1 (2020-02-28)
+## 0.2.0 (2019-09-30)
 
-* Improved CI: using GitHub actions instead of Travis.
-* Included many other checks: `safety`, `black`, `liccheck`.
-* Improved documentation.
+* Refactoring of the repository
+
+## 0.1.0 (2019-04-13)
+
+* Basic support for DFAs and NFAs.
+* Algorithms for DFA minimization and trimming.
+* Algorithm for NFA determinization.
diff --git a/README.md b/README.md
@@ -13,7 +13,15 @@
 
 Python implementation of automata theory.
 
-* Documentation: https://whitemech.github.io/pythomata.
+## Links
+
+- GitHub: https://github.com/whitemech/pythomata
+- PyPI: https://pypi.org/project/pythomata/
+- Documentation: https://whitemech.github.io/pythomata
+- Changelog: https://whitemech.github.io/pythomata/release-history/
+- Issue Tracker: https://github.com/whitemech/pythomata/issues
+- Download: https://pypi.org/project/pythomata/#files
+
 
 ## Install
 

diff --git a/docs/implement-your-automaton.md b/docs/implement-your-automaton.md
@@ -2,6 +2,7 @@
 
 If you are willing to provide your own implementation
 of an automaton, consider extending the `FiniteAutomaton`
-interface defined in [`pythomata/core.py`](../../pythomata/core.py),
+interface defined in
+[`pythomata/core.py`](https://github.com/whitemech/pythomata/blob/master/pythomata/core.py),
 or the `DFA` interface if you are implementing a
 deterministic automaton.
diff --git a/docs/install.md b/docs/install.md
@@ -9,5 +9,6 @@ pip install pythomata
 
 For some advanced features like translation to
 DOT format, you have to install Graphviz.
-Please check their [Download page](https://www.graphviz.org/download/)
+Please follow the
+[installation instructions](https://github.com/xflr6/graphviz)
 to know how to install it on your machine.
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -6,7 +6,8 @@ implementation-agnostic interface for a generic finite automaton,
 some implementations of that interface, and other programming utilities
 for rendering and serialization/deserialization.
 
-The installation instruction are [here](./install.md)
+In the [Install](./install.md) page you
+will find the installation instructions.
 
 Please have a look to the [Quickstart](./quickstart.md)
 guide to get it started.
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -30,15 +30,15 @@ Let's design a (deterministic) finite
 An automaton that accepts that language is the following:
 
 <p align="center">
-  <img width="300" height="300" src="../../images/even01.svg" />
+  <img width="300" height="300" src="../images/even01.svg" />
 </p>
 
 in particular:
 
 - the set of states $q = \{q_0, q_1, q_2, q_3\}$
 - the alphabet $\sigma = \{0, 1\}$
 - the initial state $q_0$
-- the set of accepting states $f = \{q_0\}$
+- the set of accepting states $F = \{q_0\}$
 - the transition $\delta$ defined as follows:
     - for $q_0$: $\delta(q_0, 0) = q_2$ and $\delta(q_0, 1) = q_1$
     - for $q_1$: $\delta(q_1, 0) = q_3$ and $\delta(q_1, 1) = q_0$
@@ -50,7 +50,7 @@ in particular:
 The definition in Pythomata is straightforward, since there's
 a one-to-one mapping to code.
 
-the set of states $q$:
+the set of states $Q$:
 
 ```python
 states = {"q0", "q1", "q2", "q3"}
@@ -68,7 +68,7 @@ the initial state $q_0$:
 initial_state = "q0"
 ```
 
-the set of accepting states $f$:
+the set of accepting states $F$:
 
 ```python
 accepting_states = {"q0"}
@@ -173,5 +173,5 @@ Check your current working directory, you should find
 a file called `my-even-01-automaton.svg`:
 
 <p align="center">
-  <img width="150" height="300" src="../../images/my-even-01-automaton.svg" />
+  <img width="150" height="300" src="../images/my-even-01-automaton.svg" />
 </p>