Skip to content

Commit

Permalink
Update license and README
Browse files Browse the repository at this point in the history
  • Loading branch information
mrkline committed Mar 8, 2015
1 parent c9c1bdc commit 560606f
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 19 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Licenze (zlib)

Copyright (C) 2014 Matt Kline
Copyright (C) 2015 Matt Kline

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
Expand Down
61 changes: 43 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,49 @@

## What the?

promptd generates a shell prompt (or part of it).
Right now it prints a [fish](http://fishshell.com/)-like shortening
of your current directory.
promptd is a set of tools for shell prompts.
It currently has two parts:

- `promptd-path`, which prints a [fish](http://fishshell.com/)-like shortening
of your current directory.

- `promptd-vcs`, which uses glyphs to give you a quick overview of your Git
Unlike existing solutions such as the
[vcs_info](http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Gathering-information-from-version-control-systems)
plugin for ZSH, `promptd-vcs` stops running after a user-specified amount of
time, so that fetching the status of your repo doesn't make your prompt laggy.

Together, you can use them to build a prompt like this:

![promptd example](http://i.imgur.com/tqmjAUZ.png)

More to follow.

## Why is it called promptd?

It's a prompt that gives the current _d_irectory.
It's a prompt that gives the current <em>d</em>irectory.
Or it's a prompt written in [D](http://dlang.org).
Or I suck at naming things.
Take your pick.

## It's 2014. Why are you generating a prompt with a compiled program?
## How do I get it?

Linux builds can be found at the
[releases](https://github.com/mrkline/promptd/releases) page.
They haven't been tested extensively across many distros,
but Probably Work™ since they only depend on vanilla C libraries
(pthread, libm, librt, libc).

Alternatively, building form source is simple.

## How do I build it?

Grab a [D compiler](http://dlang.org/download.html) and run `make release`.
That's all.

promptd will be added as a [Dub](http://code.dlang.org) package soon-ish.

## It's 2015. Why are you generating a prompt with a compiled program?

I was using zsh with [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh)
but it seemed to be really slow in some cases and someone on Reddit
Expand All @@ -25,25 +56,19 @@ After doing that, all that remained was having a decent prompt.
I wanted something like what fish offers, and since I'm allergic
to writing a shell script more than five lines long
([ew](http://www.zsh.org/mla/workers/2009/msg00415.html))
I [bashed](http://http://instantrimshot.com/) something out in D.
I [bashed](http://instantrimshot.com/) something out in D.
Similarly, the things I might add to the prompt seem easier in a "real"
programming language instead of a zsh script.

Yeah, it's pretty dumb to have your prompt setup be a compiled program
because then you have to recompile it to make tweaks and
you can't just download it and go.
But this is pretty much just for my use and to mess around.
## What additions are planned?

- Support for additional VCSes, starting with SVN and Mercurial

## What are you going to add?
- Additional Git info (such as the name of a branch being merged)

- [ ] Colors (something like coloring only the directory name?)
- [x] Some command line options
(though it's equally arguable that it would be cleaner
to just change the source and recompile for such a small program)
- [ ] Possibly VCS integration, though apparently zsh has a nice
[plugin](http://arjanvandergaag.nl/blog/customize-zsh-prompt-with-vcs-info.html)
for that.
- Colorized path output

## License

zlib (Use it for whatever but don't claim you wrote it.)
See `LICENSE.md`

0 comments on commit 560606f

Please sign in to comment.