README.md

ZSH Lighthaus

A ZSH Prompt that compliments the Lighthaus theme.

Table of Contents

• Features
• Screenshots
• Installation
• Version
• Bugs/Issues
• License

Features

The Lighthaus prompt is lightweight and offers minimal features for the everyday user. Some of the features include:

• Git information
• SSH information
• Python Virtual Environment information
• Background jobs
• Return Codes

Github or Gitlab symbol shown depending on the origin of the repo.

Git symbols used:

• ❗ : Branch status dirty
• ✔ : Branch status clean
• ↑ : Git Branch ahead
• ↓ : Git Branch behind
• ♺ : File/Files modified
• × : File/Files deleted
• » : File/Files renamed
• + : File/Files staged

Screenshots

Folders are shown at a depth of 2

Command return codes are displayed

Git status shown. (Git symbol displayed before branch name requires Font Awesome)

Github or Gitlab logos shown, depending on the origin of the repo

Python Virtual Env information

Git Demo

Installation

• Download the .zip and unzip it.

• Copy the lighthaus.zsh-theme from src folder into oh-my-zsh/themes/

  • Refer to oh-my-zsh's official documentation for further information.

• To activate the theme, edit your .zshrc file

  • ZSH_THEME="lighthaus.zsh-theme"

Some MacOS users might encounter an issue with unicode characters not being rendered properly. Downloading and installing the Quivira Font solves this issue.

Version

v 1.1.2

Lighthaus and all it's projects use Semantic Versioning.
All changes are recorded in CHANGELOG

Bugs/Issues

Please report any bugs or issues here.

License

Copyright © 2020-Present Lighthaus Theme

Copyright © 2020-Present Adhiraj Sirohi

Copyright © 2020-Present Vasundhara Sharma