Creates quick start (#254)
Creates a quick start. Updates documentation.
This commit is contained in:
parent
403584e735
commit
7762d94336
5 changed files with 44 additions and 11 deletions
|
|
@ -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"
|
=== "Windows"
|
||||||
Using _command prompt_, _git bash_, or _powershell_, run:
|
Using _command prompt_, _git bash_, or _powershell_, run:
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
---
|
---
|
||||||
title: ModernUO
|
title: Home
|
||||||
template: home.html
|
template: home.html
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ title: Installation
|
||||||
!!! Tip
|
!!! Tip
|
||||||
Use Git Bash as your command prompt. This can be found in the Windows Start Menu after installation.
|
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. Navigate to the folder where you want to install ModernUO.
|
||||||
1. Using _Git Bash_ run:
|
1. Using _Git Bash_ run:
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -21,14 +21,14 @@ title: Installation
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "OSX"
|
=== "OSX"
|
||||||
### Prerequisites
|
<h3>Prerequisites</h3>
|
||||||
1. Download and install the latest [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1)
|
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:
|
1. Using _terminal_, install [homebrew](https://brew.sh) and git:
|
||||||
```bash
|
```bash
|
||||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||||||
brew install git
|
brew install git
|
||||||
```
|
```
|
||||||
### Clone the Repository (Install ModernUO)
|
<h3>Install ModernUO</h3>
|
||||||
1. Using _terminal_, navigate to the folder where you want to install ModernUO and run:
|
1. Using _terminal_, navigate to the folder where you want to install ModernUO and run:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/modernuo/modernuo
|
git clone https://github.com/modernuo/modernuo
|
||||||
|
|
@ -36,7 +36,7 @@ title: Installation
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "Linux"
|
=== "Linux"
|
||||||
### Prerequisites
|
<h3>Prerequisites</h3>
|
||||||
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 Core SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux))
|
||||||
1. Using _bash_, install git:
|
1. Using _bash_, install git:
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -46,7 +46,7 @@ title: Installation
|
||||||
!!! Note
|
!!! Note
|
||||||
The command to install git might be different for your flavor of linux. Consult your local Google search for answers.
|
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)
|
<h3>Install ModernUO</h3>
|
||||||
1. Using _bash_, navigate to the folder where you want to install ModernUO and run:
|
1. Using _bash_, navigate to the folder where you want to install ModernUO and run:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/modernuo/modernuo
|
git clone https://github.com/modernuo/modernuo
|
||||||
|
|
|
||||||
28
docs/quick-start.md
Normal file
28
docs/quick-start.md
Normal file
|
|
@ -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.
|
||||||
|
|
@ -66,6 +66,7 @@ markdown_extensions:
|
||||||
# Pages
|
# Pages
|
||||||
nav:
|
nav:
|
||||||
- Home: 'index.md'
|
- Home: 'index.md'
|
||||||
- Get Started:
|
- 'Get Started':
|
||||||
- Installation: installation.md
|
- 'quick-start.md'
|
||||||
- Building the Server: building-server.md
|
- 'installation.md'
|
||||||
|
- 'building-server.md'
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue