Custom Unix Terminal

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, which contains my shell and terminal configurations.

Table of Contents

• Custom Unix Terminal
  • Requirements
  • Quick Start
  • Build & Development
    • Automation Scripts
      • update_repo.py
      • update-changelog.bash
  • License

Requirements

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

• Python 3.10 or higher (Download Python)
• uv (a fast Python package manager and resolver)

Quick Start

To preview the Bash Style Guide locally:

1. Ensure you have Python 3.10+ installed.
2. Install uv.
3. Install dependencies:

   uv sync

4. Start the development server:

   uv run mkdocs serve

5. Open http://localhost:8000 in your browser.

Or, visit the hosted version at cut.hthompson.dev.

Build & Development

• Install dependencies:

  uv sync

• Serve locally for live preview:

  uv run mkdocs serve

• Build the static site for deployment:

  uv run mkdocs build

• Deploy to GitHub Pages (if configured):

  uv run mkdocs gh-deploy

Automation Scripts

These scripts are integrated with the CI/CD workflow, but can also be run manually.

Note

The automation scripts do not require the dependencies installed via uv. Those dependencies are only needed for MkDocs site development and deployment.

update_repo.py

Updates the configuration files in includes/ from the dotfiles submodule.

Manual usage:

1. Ensure the submodules/dotfiles submodule is initialized and up to date:

   git submodule update --init --remote submodules/dotfiles

2. Run the script:

   python3 update_repo.py

update-changelog.bash

Updates CHANGELOG.md with recent changes from the dotfiles submodule.

Manual usage:

1. Ensure the submodules/dotfiles submodule is initialized and up to date:

   git submodule update --init --remote submodules/dotfiles

2. Run the script:

   bash update-changelog.bash

License

This project is licensed under the MIT License.