Skip to content

Commit

Permalink
Add homepage to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rozukke committed Jun 23, 2024
1 parent 1a70cbc commit 0338bf5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
10 changes: 6 additions & 4 deletions Doxyfile
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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 \
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0338bf5

Please sign in to comment.