From 573ddfa27b5fa4ac301261dc351e7c0afe33a820 Mon Sep 17 00:00:00 2001 From: Kamron Batman <3953314+kamronbatman@users.noreply.github.com> Date: Mon, 3 Jan 2022 19:05:28 -0800 Subject: [PATCH] docs: Updates installation docs for the main site. (#911) --- README.md | 11 ++++++++--- docs/assets/stylesheets/extra.css | 4 ++++ docs/building-server.md | 4 +++- docs/installation.md | 6 +++--- docs/overrides/.icons/brands/linuxmint.svg | 1 + docs/quick-start.md | 17 +++++++++++------ 6 files changed, 30 insertions(+), 13 deletions(-) create mode 100644 docs/overrides/.icons/brands/linuxmint.svg diff --git a/README.md b/README.md index 87a102ff7..0983a8826 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,17 @@ ModernUO [![Discord](https://img.shields.io/discord/751317910504603701?logo=disc ![MacOS 10.15/11/12](https://img.shields.io/badge/-monterey-222222?logo=apple&logoColor=white) [![Debian 10/11](https://img.shields.io/badge/-bullseye-A81D33?logo=debian)](https://www.debian.org/distrib/) [![Ubuntu 16/18/20 LTS](https://img.shields.io/badge/-20LTS-E95420?logo=ubuntu&logoColor=white)](https://ubuntu.com/download/server) +[![Linux Mint 17/18/19/20](https://img.shields.io/badge/-20-87CF3E?logo=linux%20mint&logoColor=white)](https://linuxmint.com/download.php) [![CentOS 7/8](https://img.shields.io/badge/-8.5-262577?logo=centos&logoColor=white)](https://www.centos.org/download/) [![Fedora 32/33/34](https://img.shields.io/badge/-fedora%2034-0B57A4)](https://getfedora.org/en/server/download/) [![RedHat 7/8](https://img.shields.io/badge/-8-BE0000?logo=red%20hat&logoColor=white)](https://access.redhat.com/downloads) #### Running the server -[![.NET](https://img.shields.io/badge/.NET-%206.0-5C2D91)](https://dotnet.microsoft.com/download/dotnet/6.0) +[![.NET](https://img.shields.io/badge/-6.0-5C2D91?logo=.NET)](https://dotnet.microsoft.com/download/dotnet/6.0) #### Development [![git](https://img.shields.io/badge/-git-F05032?logo=git&logoColor=white)](https://git-scm.com/downloads) -[![.NET](https://img.shields.io/badge/.NET-%206.0%20SDK-5C2D91)](https://dotnet.microsoft.com/download/dotnet/6.0) +[![.NET](https://img.shields.io/badge/-%206.0%20SDK-5C2D91?logo=.NET)](https://dotnet.microsoft.com/download/dotnet/6.0) #### Supported IDEs     @@ -51,11 +52,12 @@ Rider 2021.3+           & - `win` - Windows 10/11/2016/2019/2022 - `osx` - MacOS 10.15/11.0+/12.0+ (Catalina, Big Sur, Monterey) - `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04` - Ubuntu LTS + - `linuxmint.17`, `linuxmint.18`, `linuxmint.19` - Linux Mint - `debian.10`, `debian.11` - Debian - `centos.7`, `centos.8` - CentOS - `fedora.32`, `fedora.33`, `fedora.34` - Fedora - `rhel.7`, `rhel.8` - Redhat - - If blank, the operating system running the build is used + - If blank, the operating system running the build is used. Linux Mint 20 is not supported directly yet, so build explicitly against `ubuntu.20.04` instead. **Note:** Building in Visual Studio (or Rider) will not run the schema migration. The schema migration ensures future changes to the code will be backward compatible. @@ -64,6 +66,9 @@ to the code will be backward compatible. - Follow the [publish](https://github.com/modernuo/ModernUO#publishing-builds) instructions - Run `ModernUO.exe` or `dotnet ModernUO.dll` from the `Distribution` directory on the server +**Note:** If you are running a version of linux that isn't listed above, then you may have to install the following using a package manager: + * `libargon2-dev`, `libz-dev`, and `zstd` + ## Thanks - RunUO Team & Community - ServUO Team & Community diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css index 361f284ce..73389904f 100644 --- a/docs/assets/stylesheets/extra.css +++ b/docs/assets/stylesheets/extra.css @@ -82,6 +82,10 @@ html .md-footer-meta.md-typeset a:hover { color: #e95420; } +.linuxmint { + color: #87CF3E; +} + .debian { color: #d70a53; } diff --git a/docs/building-server.md b/docs/building-server.md index b167e1c6a..232f1f930 100644 --- a/docs/building-server.md +++ b/docs/building-server.md @@ -23,6 +23,8 @@ The operating system to build the server against. If not specified then the serv :fontawesome-brands-windows:{: .windows } `win`
:fontawesome-brands-apple:{: .apple } `osx`
-:fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`
+:fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.14.04` `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`
+:brands-linuxmint:{: .linuxmint } `linuxmint.17` `linuxmint.18`, `linuxmint.19`
:brands-debian:{: .debian } `debian.9`, `debian.10`
:fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8` +:fontawesome-brands-redhat:{: .redhat } `redhat.7`, `redhat.8` diff --git a/docs/installation.md b/docs/installation.md index a6bd079ec..6fcb6d794 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -6,7 +6,7 @@ title: Installation === "Windows" ### Prerequisites - 1. Download and install the latest [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) + 1. Download and install the latest [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0) 1. Download and install from [here](https://git-scm.com/download/win) !!! Tip @@ -22,7 +22,7 @@ title: Installation === "OSX"

Prerequisites

- 1. Download and install the latest [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) + 1. Download and install the latest [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0) 1. Using _terminal_, install [homebrew](https://brew.sh) and git: ```bash /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" @@ -37,7 +37,7 @@ title: Installation === "Linux"

Prerequisites

- 1. Download and install the latest [.NET Core SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) + 1. Download and install the latest [.NET 6 SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) 1. Using _bash_, install git: ```bash sudo apt update && sudo apt install git diff --git a/docs/overrides/.icons/brands/linuxmint.svg b/docs/overrides/.icons/brands/linuxmint.svg new file mode 100644 index 000000000..a9dcf1131 --- /dev/null +++ b/docs/overrides/.icons/brands/linuxmint.svg @@ -0,0 +1 @@ +Linux Mint \ No newline at end of file diff --git a/docs/quick-start.md b/docs/quick-start.md index 189b4841e..bd14b4f75 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -7,20 +7,25 @@ title: Quick Start If you are familiar with RunUO, then follow these steps to get your ModernUO server running in less than 10 minutes: === "Windows" - 1. Download and install the [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/5.0) - 1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. + 1. Download and install the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0) + 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder. + 1. Run publish.cmd 1. Navigate to the _Distribution_ folder. 1. Run `ModernUO.exe` === "OSX" - 1. Download and install the [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/5.0) - 1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. + 1. Download and install the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0) + 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder. + 1. Using _terminal_, navigate to the _ModernUO_ folder. + 1. Run `./publish.cmd` 1. Using _terminal_, navigate to the _Distribution_ folder. 1. Run `dotnet ModernUO.dll` === "Linux" - 1. Download and install the [.NET 5 Runtime](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) - 1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. + 1. Download and install the [.NET 6 Runtime](https://docs.microsoft.com/en-us/dotnet/core/install/linux) + 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder. + 1. Using _bash_, navigate to the _ModernUO_ folder. + 1. Run `./publish.cmd` 1. Using _bash_, navigate to the _Distribution_ folder. 1. Run `dotnet ModernUO.dll`