Skip to content

Commit 0f9176a

Browse files
committed
Update README
I knew I'd forgotten something.
1 parent 0443977 commit 0f9176a

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
[Nathan Barker](https://www.dpmms.cam.ac.uk/~nb443/) and [Andrew Duncan](http://www.mas.ncl.ac.uk/~najd2/) are currently preparing a paper entitled *The power conjugacy problem in Thompson's group V*, which describes an algorithm to solve the power conjugacy problem in the Higman-Thompson groups $G_{n,r}$.
1+
[Nathan Barker](https://www.dpmms.cam.ac.uk/~nb443/), [Andrew Duncan](http://www.mas.ncl.ac.uk/~najd2/) and [David Robertson](https://www.students.ncl.ac.uk/d.m.robertson/) are currently preparing a paper entitled *The power conjugacy problem in Higman-Thompson groups* which describes an algorithm to solve a certain equation in the groups named $G_{n,r}$.
2+
3+
This package aims to implement the algorithms described in the paper. To do so it provides tools for working in
4+
5+
- the algebra $V_{n,r}$, a certain set of words, and
6+
- the automorphism group $G_{n,r} = \Aut V_{n,r}$.
27

3-
This is a package for Python 3.3+ which aims to implement that algorithm. To do so it provides tools for working with the algebra $V_{n,r}$.
48

59
Installation
610
------------
@@ -14,6 +18,6 @@ or download [the ZIPped version](https://github.com/DMRobertson/thompsons_v/arch
1418
Documentation
1519
-------------
1620

17-
Documentation is automatically built by [Read the Docs](http://thompsons-v.readthedocs.org/en/latest/).
21+
Documentation is automatically built by [Read the Docs](http://thompsons-v.readthedocs.org/).
1822

1923
The HTML documentation is generated using [Sphinx](https://pypi.python.org/pypi/Sphinx). To build, ensure that Sphinx is installed (``pip install sphinx``), then navigate to [the docs folder](/docs) and run ``make html``. More interestingly, I'm using Sphinx's [doctest extension](http://sphinx-doc.org/ext/doctest.html) to run some simple automated tests. To use it, ensure Sphinx is installed and run ``make doctest`` from the docs directory.

docs/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ The implementation is written in `Python <python.org>`_ and runs under Python 3.
3737

3838
.. todo::
3939

40-
Make this available under an open-source license?
41-
Installation instructions/ Tutorial
40+
Make this available under an open-source license.
4241

4342
Contents
4443
--------

0 commit comments

Comments
 (0)