diff --git a/Doxyfile b/Doxyfile index ae69ee5..8d3841e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -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 diff --git a/README.md b/README.md index 5458af4..591ff02 100644 --- a/README.md +++ b/README.md @@ -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)! diff --git a/docs/mainpage.dox b/docs/mainpage.dox new file mode 100644 index 0000000..cdafe07 --- /dev/null +++ b/docs/mainpage.dox @@ -0,0 +1,38 @@ +/*! \mainpage aging + *
+ +
aging genuinely is not golly +

+ * + * **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)! + */