Skip to content

Commit

Permalink
Merge branch 'master' of http://github.com/mcpcpc/kfc
Browse files Browse the repository at this point in the history
  • Loading branch information
mcpcpc committed Jul 13, 2020
2 parents 5f0e8cf + 593f1fa commit 14070d4
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,32 @@ BACKGROUND

This project was inspired by Dylan Arap's POSIX shell script, okpal [0]. This
application has similar functionality to okpal but is designed with execution
speed in mind. Compatibility with the following terminator emulators on KISS
Linux have been tested at this time:

- simple terminal, st [2]
- alacritty [3]

Other than a terminal emulator and C compiler (e.g. gcc), the application has no
other dependencies.

Note: I apologize for the "ugliness" of the code at this time. I hope to address
this in future commits.
speed in mind. There are currently >250 light and dark palettes offered at
this time within this package (with more to come).


INSTALLATION
------------

Building and installing from source:
Other than a terminal emulator and C compiler (e.g. gcc), the application has
no other dependencies.

$ git clone https://github.com/mcpcpc/kfc.git
$ cd kfc/
$ make
$ make install
- Building and installing from source:

$ git clone https://github.com/mcpcpc/kfc.git
$ cd kfc/
$ make
$ make install

Installing on KISS Linux:
- Installing on KISS Linux:

$ kiss b kfc && kiss i kfc
$ kiss b kfc && kiss i kfc

Compatibility with the following terminator emulators on KISS Linux have been
tested:

- simple terminal, st [2]
- alacritty [3]


USAGE
Expand All @@ -58,7 +57,7 @@ EXAMPLES
the following line to one of your system startup files (e.g ~/.profile,
~/.ashrc or ~/.bashrc):

$ [ -x "$(command -v kfc)" ] && kfc -s PALETTE
[ -x "$(command -v kfc)" ] && kfc -s PALETTE

Remember to replace PALETTE in the line above with your preferred color
palette.
Expand Down

0 comments on commit 14070d4

Please sign in to comment.