oh-my-posh/README.md

82 lines
3.3 KiB
Markdown
Raw Normal View History

2022-03-18 12:15:06 -07:00
<!-- markdownlint-disable -->
<p align="center">
<img
width="400"
2022-05-12 22:54:59 -07:00
src="https://raw.githubusercontent.com/jandedobbeleer/oh-my-posh/main/website/static/img/logo.png"
2022-03-18 12:15:06 -07:00
alt="Oh My Posh Prompt theme engine for any shell"
/>
</p>
<!-- markdownlint-enable -->
<!-- markdownlint-disable first-header-h1 -->
2019-03-13 04:14:30 -07:00
2020-10-04 11:24:52 -07:00
![Release Status][release-status]
2021-05-15 04:41:01 -07:00
[![Release][release-badge]][release]
2020-10-04 11:24:52 -07:00
[![Documentation][docs-badge]][docs]
2019-03-13 04:14:30 -07:00
2021-05-15 04:41:01 -07:00
![GitHub Downloads][gh-downloads]
2021-12-22 04:22:59 -08:00
![Twitter][twitter]
2022-02-03 02:58:57 -08:00
This repo was made with love using GitKraken.
[![GitKraken shield][kraken]][kraken-ref]
What started as the offspring of [oh-my-posh2][oh-my-posh2] for PowerShell resulted in a cross platform,
2020-12-14 04:06:19 -08:00
highly customizable and extensible prompt theme engine. After 4 years of working on oh-my-posh,
a modern and more efficient tool was needed to suit my personal needs.
2019-03-13 04:14:30 -07:00
## ❤ Support ❤
2022-03-18 12:15:06 -07:00
[![Swag][swag-badge]][swag] - Show your love with a t-shirt!
[![GitHub][github-badge]][github-sponsors] - One time support, or a recurring donation?
[![Ko-Fi][kofi-badge]][kofi] - No coffee, no code.
2019-03-13 04:14:30 -07:00
## Features
2022-02-28 04:07:10 -08:00
* Shell and platform agnostic
* Easily configurable
* The **most** configurable prompt utility
2021-12-22 04:22:59 -08:00
* Fast
2022-02-28 04:07:10 -08:00
* Secondary prompt
* Right prompt
* Transient prompt
2019-03-13 04:14:30 -07:00
2020-10-04 11:24:52 -07:00
## Documentation
2019-03-13 04:14:30 -07:00
2020-10-04 11:24:52 -07:00
[![Documentation][docs-badge]][docs]
2019-03-13 04:14:30 -07:00
## Thanks
* [Chris Benti][chrisbenti-psconfig] for providing the first influence to start oh-my-posh
* [Keith Dahlby][keithdahlby-poshgit] for creating posh-git and making life more enjoyable
* [Robby Russel][oh-my-zsh] for creating oh-my-zsh, without him this would probably not be here
2020-12-14 04:06:19 -08:00
* [Janne Mareike Koschinski][justjanne] for providing information on how to get certain information
using Go (and the amazing [README][powerline-go])
2020-12-22 10:31:20 -08:00
* [Starship][starship] for creating an amazing way to initialize the prompt
2019-03-13 04:14:30 -07:00
2021-05-15 04:41:01 -07:00
[release-status]: https://img.shields.io/github/workflow/status/jandedobbeleer/oh-my-posh/Release?label=Build
[gh-downloads]: https://img.shields.io/github/downloads/jandedobbeleer/oh-my-posh/total?color=pink&label=GitHub%20Downloads
2021-12-22 04:22:59 -08:00
[twitter]: https://shields.io/twitter/follow/jandedobbeleer?label=Follow
2022-02-03 02:58:57 -08:00
[kraken]: https://img.shields.io/badge/GitKraken-Legendary%20Git%20Tools-teal?style=plastic&logo=gitkraken
[kraken-ref]: https://www.gitkraken.com/invite/nQmDPR9D
[oh-my-posh2]: https://github.com/JanDeDobbeleer/oh-my-posh2
2022-03-18 12:15:06 -07:00
[swag-badge]: https://img.shields.io/badge/Swag-Get%20some!-blue
[swag]: https://swag.ohmyposh.dev
[github-badge]: https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors
[github-sponsors]: https://github.com/sponsors/JanDeDobbeleer
2019-03-13 04:14:30 -07:00
[kofi-badge]: https://img.shields.io/badge/Ko--fi-Buy%20me%20a%20coffee!-%2346b798.svg
[kofi]: https://ko-fi.com/jandedobbeleer
2021-05-15 04:41:01 -07:00
[docs-badge]: https://img.shields.io/badge/Docs-ohmyposh.dev-blue
2022-03-18 12:15:06 -07:00
[docs]: https://ohmyposh.dev
2021-05-15 04:41:01 -07:00
[release-badge]: https://img.shields.io/github/v/release/jandedobbeleer/oh-my-posh?label=Release
[release]: https://github.com/JanDeDobbeleer/oh-my-posh/releases/latest
2019-03-13 04:14:30 -07:00
[chrisbenti-psconfig]: https://github.com/chrisbenti/PS-Config
[keithdahlby-poshgit]: https://github.com/dahlbyk/posh-git
[oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
[justjanne]: https://github.com/justjanne
[powerline-go]: https://github.com/justjanne/powerline-go
2020-12-22 10:31:20 -08:00
[starship]: https://github.com/starship/starship/blob/master/src/init/mod.rs