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

Commit

Permalink
Documenting the main page
Browse files Browse the repository at this point in the history
  • Loading branch information
Ballasi committed May 23, 2020
1 parent 9fc6ab4 commit 43d40b8
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = src
INPUT = src docs/mainpage.dox

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ The command `make` will compile the program.
## Docs

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

Join us on [Discord](https://discord.gg/35ySzjU)!
38 changes: 38 additions & 0 deletions docs/mainpage.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/*! \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/>
*
* **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, ...)
*
* \section install Installation
*
* \subsection dependencies Dependencies
*
* Here are the packages aging depends on on Linux:
*
* - `make` (as `make` with pacman and apt-get)
* - `cmake` (as `cmake` with pacman and apt-get)
* - `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
*
* For now, aging is only available through the AUR under the package name `aging` for Arch users.
*
* The package will soon be available for Debian users.
*
* If the program isn't available for you, you can build it by yourself.
*
* \subsection build Build the program
*
* Issuing the command `make` in the root directory of [the project](https://gitlab.com/aging-team/aging) will compile and link the program.
*
* The command `make run` compiles and run the program.
*
* \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)!
*/

0 comments on commit 43d40b8

Please sign in to comment.