Update README

This commit is contained in:
Frederik Hanghøj Iversen 2018-05-31 02:05:56 +02:00
parent 66e5f46912
commit 93871358a3

View file

@ -1,14 +1,14 @@
Description Description
=========== ===========
This project aims to formalize some parts of category theory using cubical agda This project aims to formalize some parts of category theory using cubical agda
— an extension to agda permitting univalence. To learn more about this — an extension to agda permitting univalence. To learn more about this
[read the docs](https://agda.readthedocs.io/en/latest/language/cubical.html). [read the docs](https://agda.readthedocs.io/en/latest/language/cubical.html).
This project draws a lot of inspiration from [the This project draws a lot of inspiration from [the
HoTT-book](https://homotopytypetheory.org/book/). HoTT-book](https://homotopytypetheory.org/book/).
If you want more information about this project, then you're in luck. This is my If you want more information about this project, then you're in luck. This is my
masters thesis. Go ahead and read it: masters thesis. Go ahead and read it:
cd doc/ cd doc/
make make
@ -17,17 +17,14 @@ Dependencies
============ ============
To successfully compile the following is needed: To successfully compile the following is needed:
* The Agda release candidate 2.5.4 or higher[^1] * The master branch of Agda.
* [Agda Standard Library](https://github.com/agda/agda-stdlib) * [Agda Standard Library](https://github.com/agda/agda-stdlib)
* [Cubical](https://github.com/Saizan/cubical-demo/) * [Cubical](https://github.com/Saizan/cubical-demo/)
Also tested with: Has been tested with:
* Agda version 2.6.0-d3efe64 * Agda version 2.6.0-d3efe64
[^1]: At least version >=
[`707ce6042`](https://github.com/agda/agda/commit/707ce6042b6a3bdb26521f3fe8dfe5d8a8470a43)
Building Building
======== ========
You can build the library with You can build the library with
@ -37,7 +34,7 @@ You can build the library with
The Makefile takes care of using the right dependencies. The Makefile takes care of using the right dependencies.
Unfortunately I have not found a way to automatically inform Unfortunately I have not found a way to automatically inform
`agda-mode` that it should use these dependencies. So what you can do `agda-mode` that it should use these dependencies. So what you can do
in stead is to copy these libraries to a global location and then add in stead is to copy these libraries to a global location and then add
them system wide: them system wide: