From 0338bf5c1c6b8a1261f229c571650b299980bd26 Mon Sep 17 00:00:00 2001 From: Artemis Rosman <73006620+rozukke@users.noreply.github.com> Date: Sun, 23 Jun 2024 23:32:15 +1000 Subject: [PATCH] Add homepage to docs --- Doxyfile | 10 ++++++---- README.md | 3 +++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/Doxyfile b/Doxyfile index c55489e5..3683d109 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,7 +1,7 @@ DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "MCPP" +PROJECT_NAME = "mcpp" PROJECT_NUMBER = -PROJECT_BRIEF = +PROJECT_BRIEF = "mcpp is a library that lets you interact with Minecraft using C++" PROJECT_LOGO = OUTPUT_DIRECTORY = ./doc/ CREATE_SUBDIRS = NO @@ -104,7 +104,9 @@ WARN_NO_PARAMDOC = NO WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = -INPUT = ./include/mcpp +INPUT = include/mcpp \ + README.md + INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.cc \ @@ -164,7 +166,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES diff --git a/README.md b/README.md index da16d092..de067f73 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,10 @@ **mcpp** (Minecraft++) is a library built to interface with Minecraft through [Spigot server](https://www.spigotmc.org/) running the [ELCI](https://github.com/rozukke/ELCI) plugin and using C++. It is currently limited to MacOS/Linux or Windows with WSL. +## Documentation + ➡ For more details on the broad strokes of **mcpp**, refer to the [wiki](https://github.com/rozukke/mcpp/wiki/Index)! +➡ Access the documentation hosted on this repo: [mcpp documentation](https://rozukke.github.io/mcpp/) ## History This library is based on [mcpi](https://github.com/martinohanlon/mcpi), which is a Python library with similar functionality.