Skip to content
This repository has been archived by the owner on Jun 18, 2023. It is now read-only.

Commit

Permalink
More documentation on the main page and the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Ballasi committed May 24, 2020
1 parent 43d40b8 commit a1fae0a
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 9 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@

**aging** is an application to explore the [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) cellular automata using various algorithms (Life, Hashlife, ...)

<div align="center">
<img src="https://cdn.discordapp.com/attachments/414542714365935626/714114855195377684/unknown.png" />
</div>

**aging** has been developed as a study project at the [Université Savoie-Mont Blanc](https://www.univ-smb.fr/en/).

## Table of contents

- [Introduction](#aging)
- [Table of contents](#table-of-contents)
- [Dependencies](#dependencies)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contribute](#contribute)

## Dependencies

Here are the packages aging depends on:
Expand All @@ -21,8 +36,12 @@ Here are the packages aging depends on:
You can run the program on a Linux machine using `make run`.
The command `make` will compile the program.

## Docs
## Documentation

The documentation can be generated by querying `make doc`. You can also find `master`'s documentation [online](http://93.7.113.241/aging/index.html).

## Contribute

The documentation can be generated by querying `make doc`. `master`'s documentation is also available [online](http://93.7.113.241/aging/index.html).
This project is free and open-source, any contributions are welcome! You can check our [issues board](https://gitlab.com/aging-team/aging/-/boards), it's usually filled with features to implement and bugs to resolve.

Join us on [Discord](https://discord.gg/35ySzjU)!
Come and chat with us in our [Discord server](https://discord.gg/35ySzjU)!
30 changes: 24 additions & 6 deletions docs/mainpage.dox
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
/*! \mainpage aging
* <div align="center">
<img src="https://cdn.discordapp.com/attachments/414542714365935626/692050409493102642/aging.png" />
<br /> <b>aging</b> genuinely is not <a href="https://sourceforge.net/projects/golly/">golly</a>
</div><br/>
* <div align="center" style="margin-bottom: 16px;">
* <img src="https://cdn.discordapp.com/attachments/414542714365935626/692050409493102642/aging.png" />
* <br /> <b>aging</b> genuinely is not <a href="https://sourceforge.net/projects/golly/">golly</a>
* </div>
*
* **aging** is an application to explore the [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) cellular automata using various algorithms (Life, Hashlife, ...)
*
* <div align="center" style="margin: 16px;">
* <img src="https://cdn.discordapp.com/attachments/414542714365935626/714114855195377684/unknown.png" />
* </div>
*
* **aging** has been developed as a study project at the [Université Savoie-Mont Blanc](https://www.univ-smb.fr/en/).
*
* \subsection table-of-contents Table of contents
*
* - [Table of contents](#table-of-contents)
* - [Installation](#install)
* * [Dependencies](#dependencies)
* * [Installation on Linux](#install-linux)
* * [Build](#build)
* - [Contribute](#contribute)
*
* \section install Installation
*
* \subsection dependencies Dependencies
Expand All @@ -17,7 +32,7 @@
* - `qt` (as `qt5` with pacman and as `qt5-default` with apt-get)
* - `gmp` (as `gmp` with pacman and as `libgmp-dev` with apt-get)
*
* \subsection install_linux Installation on Linux
* \subsection install-linux Installation on Linux
*
* For now, aging is only available through the AUR under the package name `aging` for Arch users.
*
Expand All @@ -34,5 +49,8 @@
* \section contribute Contribute
*
* You can contribute to [the project on GitLab](https://gitlab.com/aging-team/aging).
* Join us on [Discord](https://discord.gg/35ySzjU)!
*
* This project is free and open-source, any contributions are welcome! You can check our [issues board](https://gitlab.com/aging-team/aging/-/boards), it's usually filled with features to implement and bugs to resolve.
*
* Come and chat with us in our [Discord server](https://discord.gg/35ySzjU)!
*/

0 comments on commit a1fae0a

Please sign in to comment.