Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kitzunu authored Jan 5, 2025
1 parent 8894b98 commit 4c9e073
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,30 @@
# AzerothCore Doxygen Documentation

Welcome to the AzerothCore Doxygen Documentation repository! This repository holds the generated Doxygen documentation for the [AzerothCore project](https://www.azerothcore.org). The documentation is automatically updated daily via a cron job, which runs at 19:00 UTC.

The documentation site is built and deployed using [GitHub Pages](https://pages.github.com/), ensuring that it is always accessible and up-to-date.
Welcome to the AzerothCore Doxygen Documentation repository! This repository holds the generated Doxygen documentation for the [AzerothCore project](https://www.azerothcore.org). The documentation is automatically updated daily via a GitHub Workflow at 06:00 UTC.

## Overview

Doxygen is a documentation generator tool used for creating API documentation from annotated C++ source code. This repository provides an up-to-date version of the Doxygen-generated documentation for developers working on or interacting with the AzerothCore project.
Doxygen is a documentation generator tool for API documentation from annotated C++ source code. This repository provides an up-to-date version of the Doxygen-generated documentation for developers working on or interacting with the AzerothCore project.

The documentation is generated from the official AzerothCore WotLK repository:
[https://github.com/azerothcore/azerothcore-wotlk/](https://github.com/azerothcore/azerothcore-wotlk/)

The generated documentation is publicly available through the following URL:
[https://www.azerothcore.org/doxygen/](https://www.azerothcore.org/doxygen/)

The documentation site is built and deployed using [GitHub Pages](https://pages.github.com/), ensuring it is always accessible and up-to-date.
The AzerothCore Doxygen Documentation repository is publicly available through the following URL:
[https://github.com/azerothcore/doxygen/](https://github.com/azerothcore/doxygen/)

## Useful Information

- [How to document your code for Doxygen](https://www.azerothcore.org/wiki/how-to-document-code)
- [azerothcore-wotlk repository](https://github.com/azerothcore/azerothcore-wotlk)
- [Official Wiki](https://www.azerothcore.org/wiki/home)
- [C++ Code Standards](https://www.azerothcore.org/wiki/cpp-code-standards)
- [Official Website](https://www.azerothcore.org/)
- [Eluna Documentation](https://www.azerothcore.org/pages/eluna/)

---

Happy coding! 🎮

0 comments on commit 4c9e073

Please sign in to comment.