---
notoc: true
---

(getting-started)=

# Getting Started <i class="fa-solid fa-flag-checkered fa-xl"></i>

---

```{raw} html
<h2 style="font-weight: 700;"><a href="./features.html">View here for Project Features List 📝</a></h2>
```

---

## Installation

```{warning}
Currently, **_instructions only exist for MacOS-based machines_**.

Leave a note in [the project's discussions section](https://github.com/wyattowalsh/nba-db/discussions) if you need help with installation on a different OS.
```

```{raw} html
<blockquote><p style="font-size: 1.35rem; font-weight: 400;"><a href="./installation.html">View here for installation instructions 🔎</a></p></blockquote>
```

---

## Usage

```{note}
Usage instructions include general development environment initializations, interacting with the `nba_db` package, and interacting with the project's docs site.
```

```{raw} html
<blockquote><p style="font-size: 1.35rem; font-weight: 400;"><a href="#installation">View here for usage instructions 📝</a></p></blockquote>
```

---

```{toctree}
:hidden:
:titlesonly:

features
installation
usage
```