Skip to content

Commit

Permalink
Wow, such README update
Browse files Browse the repository at this point in the history
  • Loading branch information
harkabeeparolus committed Jan 4, 2024
1 parent 9aa3772 commit ff2fee1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,36 @@
doge
====

![wow screenshot](http://i.imgur.com/HxH9qka.png)
# doge

![wow screenshot](example_doge.png)

**doge** is a simple motd script based on the slightly stupid but very funny
[doge meme][doge]. It prints random grammatically incorrect statements that are
sometimes based on things from your computer.

For more information about getting a setup like the one in the screenshot, see
[this dotfiles repo][shameless].

## Features

* Randomly placed and colored random strings, complete with broken english.
* Awesome Shibe in the terminal.
* Fetching of system data, such as hostname, running processes, current user
and `$EDITOR`.
* If you have [lolcat][lolcat], you can do this gem:
* If you have [lolcat][], you can do this gem:
`while true; do doge | lolcat -a -d 100 -s 100 -p 1; done`
(thx [hom3chuk][hom3chuk])
(thx [hom3chuk][])
* stdin support: `ls /usr/bin | doge` will doge-print some of the executables
found in /usr/bin. wow. There are also multiple command line switches that
control filtering and statistical frequency of words. See `doge -h`, wow.

## Installation

`pip install doge`

*Ubuntu or Debian users may have to use `sudo -H`, see issue [#61](https://github.com/thiderman/doge/issues/61).*

If you don't want to do that for whatever reason, there is a proper `setup.py`
included, so `python setup.py install` should be just fine for that.
* `pipx install doge` (Recommended, needs [pipx][].)
* `shiv doge -c doge -o doge.pyz`
* `pex doge -c doge -o doge.pyz`
* Install with *pip*, see
[A quick-and-dirty guide on how to install packages for Python][install_guide]
for more information.
* `python3 -m pip install doge`

Note that if you are one of the unlucky doges to still run a Python that does
not have argparse (<=Python2.6) you will have to install argparse manually from
pypi. so old, very update need.
If you don't want to do that for whatever reason, there is a proper
`pyproject.toml` included, so `python -m pip install -e .` should be just fine for that.

Then, just add a call to `doge` at the bottom of your shell rc file.

Expand All @@ -50,4 +45,5 @@ The terminal Shibe was created with hax0r Gimp skills and [img2xterm][i2x].
[i2x]: https://github.com/rossy2401/img2xterm
[hom3chuk]: https://github.com/hom3chuk
[lolcat]: https://github.com/busyloop/lolcat
[shameless]: https://github.com/thiderman/dotfiles
[pipx]: https://pipx.pypa.io
[install_guide]: https://snarky.ca/a-quick-and-dirty-guide-on-how-to-install-packages-for-python/
Binary file added example_doge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ff2fee1

Please sign in to comment.