Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kitzunu authored Dec 28, 2024
1 parent eb0848d commit a410e02
Showing 1 changed file with 3 additions and 30 deletions.
33 changes: 3 additions & 30 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,7 @@
# AzerothCore WIKI
# AzerothCore Wiki

Read in: [English :gb:](README.md) | [Spanish :es:](README_es.md)
Welcome to the AzerothCore Wiki! This repository provides comprehensive documentation for setting up, configuring, and customizing the AzerothCore WoW emulator.

Wiki for the AzerothCore Project available here: http://azerothcore.github.io/wiki

## How to install locally (development)

### With [docker-compose](https://docs.docker.com/compose/install/)

1. install [docker-compose](https://docs.docker.com/compose/install/)
2. run `docker-compose up github-wiki-theme`
3. the website will be ready on `http://127.0.0.1:4000/`

### Without docker compose

First of all install the [ruby development environment](https://jekyllrb.com/docs/installation/) using [this guide](https://jekyllrb.com/docs/installation/).

After that install `bundler` using gem and run `bundler install`:

```
$ gem install bundler
$ bundle install
```

Well, now you can run locally the app using:

```
bundle exec jekyll serve
```

If everything succeds, you can visit your web app at `http://127.0.0.1:4000/`.
If you want to contribute to the wiki please open a PR in the /docs/ directory.

Any problems? [Open a issue](https://github.com/azerothcore/wiki/issues/new).

0 comments on commit a410e02

Please sign in to comment.