Setup

The o!TR Docs serve to document anything and everything related to the o!TR project and are written using Obsidian. This guide details the setup process.

Prerequisites

• Git: Ensure Git is installed on your system.
• Obsidian: Download and install Obsidian from https://obsidian.md/.

Cloning the Repository

NOTE

If you want to contribute to the docs and you are not part of our organization, you must first fork our repository and clone the version tied to your GitHub account.

See the Contribution Guide for more information.

1. Open your terminal or Git Bash (on Windows).
2. Navigate to the directory where you want to store the documentation.
3. Execute the following command to clone the repository:

git clone <YOUR FORK, OR https://github.com/osu-tournament-rating/otr-docs.git>

Opening in Obsidian

1. Open Obsidian.
2. Select “Open folder as vault” and navigate to the cloned otr-docs folder. Obsidian will then index and display the documentation.

Optional: Git Plugin

The Git plugin enables version control directly within Obsidian, allowing you to track changes, create branches, and manage your changes with ease. If you prefer not to use version control within Obsidian, feel free to skip this section.

Plugin Installation

1. Navigate to Obsidian settings.
2. Click “Community plugins”.
3. Click “Browse” and search for the “Git” plugin.
4. Install and enable the “Git” plugin.

Once installed, you can use this plugin to manage and commit changes directly within Obsidian. Refer to the Obsidian documentation and the Git plugin documentation for detailed instructions on utilizing these features.