Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,31 @@
# Custom Unix Terminal

[![Project Tracker](https://img.shields.io/badge/repo%20status-Project%20Tracker-lightgrey)](https://hthompson.dev/project-tracker#project-146955022)
[![GitHub License](https://img.shields.io/github/license/StrangeRanger/custom-unix-terminal)](LICENSE)
<br />
[![Static Badge](https://img.shields.io/badge/Click%20to%20access%20Custom%20Unix%20Terminal-blue)](https://cut.hthompson.dev)

> [!NOTE]
> To access the full Custom Unix Terminal document, click the blue badge above or navigate to [cut.hthompson.dev](https://cut.hthompson.dev).
[![Static Badge](https://img.shields.io/badge/Click%20to%20access%20Custom%20Unix%20Terminal-blue?style=for-the-badge)](https://cut.hthompson.dev)

No one asked for it, but I made it anyways because I am passionate about sharing knowledge however I can. This repository contains information regarding my terminal setup, including the tools I use, the configurations of those tools, my terminal profiles, and more. Included are instructions on how to set up and use my configurations, or at least how to get started with them.

I've attempted to make this repository as automated as possible so it always stays current. To do this, I created workflows that automate updating the files in the `includes` directory when updating my [dotfiles repository](https://github.com/StrangeRanger/dotfiles), which contains my shell and terminal configurations.

<details>
<summary><strong>Table of Contents</strong></summary>

- [Custom Unix Terminal](#custom-unix-terminal)
- [Requirements](#requirements)
- [Quick Start](#quick-start)
- [Build \& Development](#build--development)
- [Automation Scripts](#automation-scripts)
- [`update_repo.py`](#update_repopy)
- [`update-changelog.bash`](#update-changelogbash)
- [License](#license)

</details>

## Requirements

These tools are necessary **only** if you wish to build or preview the documentation locally.

- Python 3.10 or higher ([Download Python](https://www.python.org/downloads/))
- [uv](https://github.com/astral-sh/uv#installation) (a fast Python package manager and resolver)

Expand All @@ -35,16 +47,6 @@ To preview the Bash Style Guide locally:

Or, visit the hosted version at [cut.hthompson.dev](https://cut.hthompson.dev).

## Project Structure

- `docs/` — Main documentation content (guidelines, changelog, etc.)
- `docs/stylesheets/` — Custom CSS for the site
- `includes/` — Generated and reference configuration files (zsh, neovim, CSVs)
- `overrides/` — MkDocs Material theme overrides
- `submodules/dotfiles/` — Git submodule containing my dotfiles repository
- `utils/` — Python utility modules for automation scripts
- `mkdocs.yml` — MkDocs configuration

## Build & Development

- **Install dependencies:**
Expand Down Expand Up @@ -100,3 +102,7 @@ Manual usage:
```bash
bash update-changelog.bash
```

## License

This project is licensed under the [MIT License](LICENSE).