From 7762d94336a32ff10304049e29718bac88032b3a Mon Sep 17 00:00:00 2001 From: Kamron Batman <3953314+kamronbatman@users.noreply.github.com> Date: Tue, 15 Sep 2020 19:46:10 -0700 Subject: [PATCH] Creates quick start (#254) Creates a quick start. Updates documentation. --- docs/building-server.md | 8 ++++++-- docs/index.md | 2 +- docs/installation.md | 10 +++++----- docs/quick-start.md | 28 ++++++++++++++++++++++++++++ mkdocs.yml | 7 ++++--- 5 files changed, 44 insertions(+), 11 deletions(-) create mode 100644 docs/quick-start.md diff --git a/docs/building-server.md b/docs/building-server.md index 32acd4f5d..9dd9b42d7 100644 --- a/docs/building-server.md +++ b/docs/building-server.md @@ -1,6 +1,10 @@ -# Building the Server +--- +title: Creating a build +--- -## Compiling +# Creating a build + +The server software must be built before it can be run. === "Windows" Using _command prompt_, _git bash_, or _powershell_, run: diff --git a/docs/index.md b/docs/index.md index e4484eb48..487ccfec7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ --- -title: ModernUO +title: Home template: home.html --- diff --git a/docs/installation.md b/docs/installation.md index c56335ff6..409b8ca77 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -12,7 +12,7 @@ title: Installation !!! Tip Use Git Bash as your command prompt. This can be found in the Windows Start Menu after installation. - ### Clone the Repository (Install ModernUO) + ### Install ModernUO 1. Navigate to the folder where you want to install ModernUO. 1. Using _Git Bash_ run: ```bash @@ -21,14 +21,14 @@ title: Installation ``` === "OSX" - ### Prerequisites +

Prerequisites

1. Download and install the latest [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1) 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)" brew install git ``` - ### Clone the Repository (Install ModernUO) +

Install ModernUO

1. Using _terminal_, navigate to the folder where you want to install ModernUO and run: ```bash git clone https://github.com/modernuo/modernuo @@ -36,7 +36,7 @@ title: Installation ``` === "Linux" - ### Prerequisites +

Prerequisites

1. Download and install the latest [.NET Core SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) 1. Using _bash_, install git: ```bash @@ -46,7 +46,7 @@ title: Installation !!! Note The command to install git might be different for your flavor of linux. Consult your local Google search for answers. - ### Clone the Repository (Install ModernUO) +

Install ModernUO

1. Using _bash_, navigate to the folder where you want to install ModernUO and run: ```bash git clone https://github.com/modernuo/modernuo diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 000000000..18bd44e4c --- /dev/null +++ b/docs/quick-start.md @@ -0,0 +1,28 @@ +--- +title: Quick Start +--- + +# 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 Core Runtime](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-3.1.8-windows-x64-installer) + 1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. + 1. Navigate to the _Distribution_ folder. + 1. Run `ModernUO.exe` + +=== "OSX" + 1. Download and install the [.NET Core Runtime](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-aspnetcore-3.1.8-macos-x64-binaries) + 1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. + 1. Using _terminal_, navigate to the _Distribution_ folder. + 1. Run `./dotnet ModernUO.dll` + +=== "Linux" + 1. Download and install the [.NET Core 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. Using _bash_, navigate to the _Distribution_ folder. + 1. Run `./dotnet ModernUO.dll` + +!!! Note + Follow the rest of the [Get Started](../installation) guide to learn how to connect, configure, and customize, your server. diff --git a/mkdocs.yml b/mkdocs.yml index 92425373b..d0dbbf9f4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ markdown_extensions: # Pages nav: - Home: 'index.md' - - Get Started: - - Installation: installation.md - - Building the Server: building-server.md + - 'Get Started': + - 'quick-start.md' + - 'installation.md' + - 'building-server.md'