From 596a5c05e08a238bb12d7b24ff3fd32f8daf6b5f Mon Sep 17 00:00:00 2001 From: Kwoth Date: Sun, 12 Sep 2021 00:18:54 +0200 Subject: [PATCH] docs: Fixed more indentation in osx and migration guides --- docs/guides/migration-guide.md | 2 +- docs/guides/osx-guide.md | 57 +++++++++++++++++----------------- 2 files changed, 30 insertions(+), 29 deletions(-) diff --git a/docs/guides/migration-guide.md b/docs/guides/migration-guide.md index 627543fb4..3ff1224f1 100644 --- a/docs/guides/migration-guide.md +++ b/docs/guides/migration-guide.md @@ -46,7 +46,7 @@ - Then you **must** run the bot to prepare the database for the migration, and make sure the bot works prior to upgrade. Then: 2. Rename your old nadeko bot folder to `nadekobot_2x` - - `mv NadekoBot nadekobot_2x` + - `mv NadekoBot nadekobot_2x` 3. Build the new version and move old data to the output folder 1. Clone the v3 branch to a separate folder - `git clone https://gitlab.com/kwoth/nadekobot -b v3 --depth 1` diff --git a/docs/guides/osx-guide.md b/docs/guides/osx-guide.md index 046c61ba2..a2952a663 100644 --- a/docs/guides/osx-guide.md +++ b/docs/guides/osx-guide.md @@ -1,4 +1,4 @@ -### MacOS From Source +## MacOS From Source Open Terminal (if you don't know how to, click on the magnifying glass on the top right corner of your screen and type **Terminal** on the window that pops up) and navigate to the location where you want to install the bot (for example `cd ~`) @@ -6,9 +6,9 @@ Open Terminal (if you don't know how to, click on the magnifying glass on the to *Skip this step if you already have homebrew installed* - Copy and paste this command, then press Enter: -`/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` + - `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` - Install wget - - `brew install wget` + - `brew install wget` ##### Installation Instructions @@ -16,11 +16,12 @@ Open Terminal (if you don't know how to, click on the magnifying glass on the to 2. Install prerequisites (type `1` and press enter) 3. Download the bot (type `2` and press enter) 4. Exit the installer in order to set up your `creds.yml` -5. Copy the creds.yml template `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml` +5. Copy the creds.yml template + `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml` 6. Open `nadekobot/output/creds.yml` with your favorite text editor. We will use nano here - - `nano nadekobot/output/creds.yml` + - `nano nadekobot/output/creds.yml` 7. [Enter your bot's token](#creds-guide) - - After you're done, you can close nano (and save the file) by inputting, in order + - After you're done, you can close nano (and save the file) by inputting, in order - `CTRL`+`X` - `Y` - `Enter` @@ -34,7 +35,7 @@ Open Terminal (if you don't know how to, click on the magnifying glass on the to 4. Run the bot (type `3` and press enter) 5. 🎉 -### Linux Release +## MacOS Manual Release installation instructions ##### Installation Instructions @@ -42,48 +43,48 @@ Open Terminal (if you don't know how to, click on the magnifying glass on the to - Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it 2. Untar it ⚠ Make sure that you change X.XX.X to the same series of numbers as in step 1! - - `tar xf X.XX.X-linux-x64-build.tar` + - `tar xf X.XX.X-linux-x64-build.tar` 3. Rename the `nadekobot-linux-x64` to `nadekobot` - - `mv nadekobot-linux-x64 nadekobot` + - `mv nadekobot-linux-x64 nadekobot` 4. Move into nadekobot directory and make NadekoBot executable - - `cd nadekobot && chmod +x NadekoBot` + - `cd nadekobot && chmod +x NadekoBot` 5. Copy the creds.yml template - - `cp creds_example.yml creds.yml` + - `cp creds_example.yml creds.yml` 6. Open `creds.yml` with your favorite text editor. We will use nano here - - `nano nadekobot/output/creds.yml` + - `nano nadekobot/output/creds.yml` 8. [Enter your bot's token](#creds-guide) - - After you're done, you can close nano (and save the file) by inputting, in order - - `CTRL`+`X` - - `Y` - - `Enter` + - After you're done, you can close nano (and save the file) by inputting, in order + - `CTRL`+`X` + - `Y` + - `Enter` 9. Run the bot - - `./NadekoBot` + - `./NadekoBot` ##### Update Instructions 1. Stop the bot 2. Download the latest release from - - Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it + - Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it 3. Untar it ⚠ Make sure that you change X.XX.X to the same series of numbers as in step 2! - - `tar xf 2.99.8-linux-x64-build.tar` + - `tar xf 2.99.8-linux-x64-build.tar` 4. Rename the old nadekobot directory to nadekobot-old (remove your old backup first if you have one, or back it up under a different name) - - `rm -rf nadekobot-old 2>/dev/null` - - `mv nadekobot nadekobot-old` + - `rm -rf nadekobot-old 2>/dev/null` + - `mv nadekobot nadekobot-old` 5. Rename the new nadekobot directory to nadekobot - - `mv nadekobot-linux-x64 nadekobot` + - `mv nadekobot-linux-x64 nadekobot` 6. Remove old strings and aliases to avoid overwriting the updated versions of those files ⚠ If you've modified said files, back them up instead - - `rm nadekobot-old/data/aliases.yml` - - `rm -r nadekobot-old/data/strings` + - `rm nadekobot-old/data/aliases.yml` + - `rm -r nadekobot-old/data/strings` 7. Copy old data - - `cp -RT nadekobot-old/data/ nadekobot/data/` + - `cp -RT nadekobot-old/data/ nadekobot/data/` 8. Copy creds.yml - - `cp nadekobot-old/creds.yml nadekobot/` + - `cp nadekobot-old/creds.yml nadekobot/` 9. Move into nadekobot directory and make the NadekoBot executable - - `cd nadekobot && chmod +x NadekoBot` + - `cd nadekobot && chmod +x NadekoBot` 10. Run the bot - - `./NadekoBot` + - `./NadekoBot` 🎉 Enjoy