Skip to content

Commit

Permalink
README.md: Minor improvements
Browse files Browse the repository at this point in the history
Removes outdated information from Readme.md.
Add code syntax markers and fixes minor typos
  • Loading branch information
hoijui authored and abishekvashok committed Oct 28, 2017
1 parent 0096580 commit be5567e
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@ rate or asynchronously and at a user-defined speed.

CMatrix by default operates in **eye candy** mode. It must be aborted with
control-c (Ctrl+C) or by pressing q. If you wish for more of a screen saver
effect, you must specify -s on the command line. For usage, use `cmatrix -h`.
effect, you must specify `-s` on the command line. For usage info, use `cmatrix -h`.

[![Build Status](https://travis-ci.org/abishekvashok/cmatrix.svg?branch=master)](https://travis-ci.org/abishekvashok/cmatrix)
### Dependencies
You'll probably need a decent ncurses library to get this to work. I
have provided a binary that depends on ncurses 4.2 & glibc6.
You'll probably need a decent ncurses library to get this to work.

### Installing cmatrix
To install cmatrix, in the cmatrix directory run:
Expand All @@ -23,8 +22,8 @@ To install cmatrix, in the cmatrix directory run:
### Running cmatrix
After you have installed cmatrix just run `cmatrix` to run cmatrix :)

_To get the program to look most like the movie, use cmatrix -lba_
_To get the program to look most like the Win/Mac screensaver, use cmatrix -ol_
_To get the program to look most like the movie, use `cmatrix -lba`_
_To get the program to look most like the Win/Mac screensaver, use `cmatrix -ol`_

### Valuable information
If you have any suggestions/flames/patches to send, please feel free to
Expand All @@ -40,7 +39,7 @@ _Note: cmatrix is probably not particularly portable or efficient, but it wont h
- Chris Allegretta <[email protected]> for writing cmatrix up in a fornight and giving us
the responsibility to further improve it.
- Krisjon Hanson and Bjoern Ganslandt for helping with bold support and
Bjoern again for the cursor removal code, helping with the -u and -l
Bjoern again for the cursor removal code, helping with the `-u` and `-l`
modes/flags, and Makefile improvements.
- Adam Gurno for multi-color support.
- Garrick West for debian consolefont dir support.
Expand All @@ -60,5 +59,5 @@ This software is provided under the GNU GPL v3.

### Disclaimer
We are in no way affiliated in any way with the movie "The Matrix", "Warner Bros" nor
any of it's affiliates in any way. Just fans.
any of its affiliates in any way, just fans.

0 comments on commit be5567e

Please sign in to comment.