Skip to content

Commit

Permalink
Formatting/general cleaning (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
Akkarinage authored May 28, 2024
1 parent a01c911 commit 8651f72
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 16 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/deploy_guides.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
name: Publish Guides


on:
# Allow manual deployment
workflow_dispatch:

# Trigger when code is merged to `master` branch
push:
branches:
Expand All @@ -16,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Deploy docs
Expand Down
2 changes: 1 addition & 1 deletion guides/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Instead of actually pausing the execution you can use this to execute a piece of

### Anything missing?

Should you have any questions, don't hesitate to ask questions at our Discord. We'll be happy to help.
Should you have any questions, don't hesitate to ask questions at our Discord. We'll be happy to help.
6 changes: 3 additions & 3 deletions guides/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![https://github.com/rathena/rathena](img/rathena_banner_1.png)](https://github.com/rathena/rathena)

[![GitHub](https://img.shields.io/github/license/rathena/rathena?style=for-the-badge)](https://github.com/rathena/rathena/blob/master/LICENSE)
[![GitHub last commit](https://img.shields.io/github/last-commit/rathena/user-guides?label=updated&style=for-the-badge)](https://github.com/rathena/user-guides/commits/master)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rathena/user-guides/deploy_guides.yml?label=automatic%20building&style=for-the-badge)](https://github.com/rathena/user-guides/actions)
[![GitHub](https://img.shields.io/github/license/rathena/rathena?style=for-the-badge)](https://github.com/rathena/rathena/blob/master/LICENSE)
[![GitHub last commit](https://img.shields.io/github/last-commit/rathena/user-guides?label=updated&style=for-the-badge)](https://github.com/rathena/user-guides/commits/master)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rathena/user-guides/deploy_guides.yml?label=automatic%20building&style=for-the-badge)](https://github.com/rathena/user-guides/actions)
![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/rathena/user-guides?label=Open%20PR&style=for-the-badge)

# Hello~! What?!
Expand Down
11 changes: 10 additions & 1 deletion guides/installing/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,19 @@ This guide covers the installation via CLI and *does not* include instructions f
## Pre-Requisites

### In General

* A basic understanding of Linux based Operating Systems.
* A basic understanding of the SSH tool Putty.
* A basic understanding of MySQL (or RDBMS in general).
* A basic understanding of when the root system user should be used, and when you should use a standard user shell.
* A basic understanding that "if at first you don't succeed, search the forums" will be your saving-grace in the event of errors.

### Debian 10

You should ensure that your system is up-to-date by first: `apt-get update`

### Installing Requirements

We need the following applications to compile rAthena on Debian 10:
```
apt-get install git make libmariadb-dev libmariadbclient-dev libmariadbclient-dev-compat gcc g++ zlib1g-dev libpcre3-dev
Expand All @@ -29,14 +32,16 @@ apt-get install -y nano
```

### MySQL

For the installation instructions of MySQL, please see the [relevant installation page](https://github.com/rathena/rathena/wiki/Install-MySQL#linux).


## The Code Repository

rAthena uses git for revision control, and hosts the git repository on Github.

### Cloning
### Cloning

You can obtain the latest version of rAthena by typing the following command. This will place rAthena in a folder called rAthena in your home directory, but you are free to change it to whatever you like:

```
Expand Down Expand Up @@ -83,9 +88,11 @@ Recompiling is the same as compiling. You can throw the code into a one-liner, i


## Starting rAthena

The provided method of running rAthena will work perfectly fine, but this author's personal preference is shown below as an *alternative method*.

### Provided Method

Use the following commands

* To Start:
Expand Down Expand Up @@ -114,6 +121,7 @@ You can install dos2unix with `apt-get install dos2unix` and then run `dos2unix
You will now be able to use `./athena-start start` after `chmod a+x athena-start`.

### Alternative Method

Firstly, install `screen`:
```
apt-get install -y screen
Expand Down Expand Up @@ -146,6 +154,7 @@ There are screens on:
```

### Connections

If you've just started your servers and get some errors, don't worry, it's because you haven't configured them yet.

We have a handy guide [here](https://github.com/rathena/rathena/wiki/connecting) that will talk you through what you need to change in order to get your servers up and running successfully.
4 changes: 0 additions & 4 deletions guides/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,3 @@
.md-typeset a {
color: #5caed6
}

.md-typeset h1 {
color: #dae1e8;
}
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ theme:
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
icon: material/toggle-switch-off-outline
name: Switch to dark mode
primary: custom
accent: cyan
- scheme: slate
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
name: Switch to light mode
primary: custom
accent: cyan
extra:
Expand All @@ -71,7 +71,7 @@ extra:
- icon: fontawesome/solid/message
link: https://rathena.org/board/
- icon: fontawesome/brands/wikipedia-w
link: https://rathena.org/wiki/
link: https://github.com/rathena/rathena/wiki/
- icon: fontawesome/brands/discord
link: https://discord.gg/rathena-96459614895226880

Expand Down

0 comments on commit 8651f72

Please sign in to comment.