diff options
| author | Walter Pagani <paganiwalter@gmail.com> | 2021-01-16 16:12:40 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-16 16:12:40 -0300 |
| commit | a354030c3a86e561a7e3cb4a82968b23dcbaf747 (patch) | |
| tree | 4222ebeb00c0f09227d81f38b3790dbddc1b1332 | |
| parent | d3cbe4ab3ae456b7a1ed05914ea046fc64352ca0 (diff) | |
| download | wiki-a354030c3a86e561a7e3cb4a82968b23dcbaf747.tar.gz wiki-a354030c3a86e561a7e3cb4a82968b23dcbaf747.tar.bz2 wiki-a354030c3a86e561a7e3cb4a82968b23dcbaf747.zip | |
Syntax arrangement and some information (#373)
* Syntax arrangement and some information
* Adding recommendations
| -rw-r--r-- | docs/Requirements.md | 109 |
1 files changed, 90 insertions, 19 deletions
diff --git a/docs/Requirements.md b/docs/Requirements.md index 7a4df74..be729ba 100644 --- a/docs/Requirements.md +++ b/docs/Requirements.md @@ -5,71 +5,123 @@ ### Debian-based requirements #### Ubuntu -`sudo apt-get update && sudo apt-get install git cmake make gcc g++ clang libmysqlclient-dev libssl-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev` + +```sh +sudo apt-get update && sudo apt-get install git cmake make gcc g++ clang libmysqlclient-dev libssl-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev +``` + +Remember that if you are using the `root` user, it is not necessary to use `sudo`. To configure MySQL in Ubuntu 18.04 and similar (set `root` password and other settings) read [this guide](https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-18-04). ---- +**Note:** If you add the option `-y` and at the end of the list, it will start installing them without the need for you to confirm. + +**Example:** + +```sh +apt-get update && apt-get install git cmake make gcc g++ clang libmysqlclient-dev libssl-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev -y +``` +--- #### Debian 8 -`sudo apt-get update && sudo apt-get install git make gcc g++ clang libmysqlclient-dev libssl1.0-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev` +```sh +sudo apt-get update && sudo apt-get install git make gcc g++ clang libmysqlclient-dev libssl1.0-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev +``` + +Remember that if you are using the `root` user, it is not necessary to use `sudo`. #### Install last cmake version on Debian 8 To install last version of cmake use: -``` + +```sh sudo apt install python3-pip pip3 install --upgrade cmake ``` -Than **reboot** to sync the bash and use cmake from the terminal, than type the followings commands to check the cmake version: +If you are using the `root` user + +```sh +apt install python3-pip +pip3 install --upgrade cmake ``` + +Than **reboot** to sync the bash and use cmake from the terminal, than type the followings commands to check the cmake version: + +```sh cmake --version ``` + You should have a version **>= 3.8**. Continue below the guide to install the other installation requirements. **Troubleshooting (cmake install)**: if you get any errors like: `No module named 'skbuild'`, you can solve with this: -``` +```sh apt install python3-pip pip3 install scikit-build pip3 install --upgrade pip pip3 install cmake ``` +--- + #### Debian 9 -`sudo apt-get update && sudo apt-get install git cmake make gcc g++ clang default-libmysqlclient-dev libssl1.0-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev` +```sh +sudo apt-get update && sudo apt-get install git cmake make gcc g++ clang default-libmysqlclient-dev libssl1.0-dev libbz2-dev libreadline-dev libncurses-dev mysql-server libace-6.* libace-dev +``` + +Remember that if you are using the `root` user, it is not necessary to use `sudo`. You might need to add the stretch-backports repositories to APT in order to install clang-6.x+ and cmake v3.8+. If you do not succeed installing cmake you can use the package manager of python3 (pip3) +--- + #### Debian 10 -`sudo apt-get update && sudo apt-get install git cmake make gcc g++ clang default-libmysqlclient-dev libssl-dev libbz2-dev libreadline-dev libncurses-dev mariadb-server libace-6.* libace-dev` +```sh +sudo apt-get update && sudo apt-get install git cmake make gcc g++ clang default-libmysqlclient-dev libssl-dev libbz2-dev libreadline-dev libncurses-dev mariadb-server libace-6.* libace-dev +``` + +Remember that if you are using the `root` user, it is not necessary to use `sudo`. + +**Note:** If you add the option `-y` and at the end of the list, it will start installing them without the need for you to confirm. + +**Example:** + +```sh +apt-get update && apt-get install git cmake make gcc g++ clang default-libmysqlclient-dev libssl-dev libbz2-dev libreadline-dev libncurses-dev mariadb-server libace-6.* libace-dev -y +``` --- #### Check your clang version -`clang --version` +```sh +clang --version +``` Your `clang` version **MUST** be `6` or higher ([here](https://github.com/azerothcore/azerothcore-wotlk/actions?query=workflow%3Acore-build) you can check the versions that run in our Github Actions pipeline, we recommend to use one of those versions). For example, if you are using an older version of Ubuntu like 16.04, you need to install clang using: -`sudo apt-get install clang-6.0` +```sh +sudo apt-get install clang-6.0 +``` If you use another distro or version, search on google for how to install the right clang version for your system. #### Check your cmake version -`cmake --version` +```sh +cmake --version +``` Your `cmake` version **MUST** be `3.8` or higher. @@ -80,29 +132,48 @@ On an older version of Ubuntu (example: 16.04), you can follow the instructions This is an issue if for example using an older version of Ubuntu like 16.04. There you have to add the PPA "Toolchain test builds": https://launchpad.net/~ubuntu-toolchain-r/+archive/ubuntu/test -After `sudo apt-get update` you can install gcc-7: `sudo apt-get install g++-7 gcc-7` +After +```sh +sudo apt-get update +``` + +you can install gcc-7: + +```sh +sudo apt-get install g++-7 gcc-7 +``` + +--- ## Mac OS X - Install XCode using the App Store, then open the terminal and type: -`xcode-select --install` +```sh +xcode-select --install +``` - Install the package manager [Homebrew](http://brew.sh/) Use brew it to install the required packages: -`brew update` +```sh +brew update +``` -`brew install openssl readline cmake ace coreutils bash bash-completion coreutils` +```sh +brew install openssl readline cmake ace coreutils bash bash-completion coreutils +``` This will install bash 5+, you might need to restart your terminal. Make sure you are using bash 5 or newer by typing `bash --version`. Now install mysql: -`brew install mysql` +```sh +brew install mysql +``` You will be prompted some instructions to complete the `mysql` installation, for example to properly set a password. Just follow the instructions and properly configure mysql. **This step is important, do not skip it.** @@ -110,7 +181,9 @@ To verify that mysql has been properly installed, try accessing it using either You can install Sequel Ace with: -`brew cask install sequel-ace` +```sh +brew cask install sequel-ace +``` ## Windows @@ -135,5 +208,3 @@ You can install Sequel Ace with: 3. _Note #1: If you get a "Missing Microsoft Visual C++ 2008 Redistributables" error message while installing OpenSSL, download the ** [Microsoft Visual C++ 2008 Redistributable Package (x64)](http://www.microsoft.com/en-us/download/details.aspx?id=29) ** (1.7MB Installer) and install it. If you need 32bit support, download and install the [ **Microsoft Visual C++ 2008 Redistributable Package (x86)** ](http://www.microsoft.com/en-us/download/details.aspx?id=15336)._ 4. _Note #2: While installing OpenSSL, choose **The OpenSSL binaries (/bin) directory** (NOT "The Windows system directory") when given the choice on where to copy the OpenSSL DLLs. These DLLs will need to be located easily for Core Installation._ - -*** |
