amatrix

AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
git clone git://git.kocotian.pl/amatrix.git
Log | Files | Refs | README | LICENSE

README.md (3323B)


      1 # AMatrix
      2 
      3 AMatrix is based on the screensaver from The Matrix website. It shows text
      4 flying in and out in a terminal like as seen in "The Matrix" movie. It can
      5 scroll lines all at the same rate or asynchronously and at a user-defined
      6 speed.
      7 
      8 AMatrix by default operates in **eye candy** mode.  It must be aborted with
      9 control-c (Ctrl+C) or by pressing q.  If you wish for more of a screen saver
     10 effect, you must specify `-s` on the command line. For usage info, use `amatrix -h`.
     11 
     12 [![Build Status](https://travis-ci.org/abishekvashok/amatrix.svg?branch=master)](https://travis-ci.org/abishekvashok/amatrix)
     13 
     14 ### Dependencies
     15 You'll probably need a decent ncurses library (or PDCurses on native Windows) to get this to work.
     16 
     17 ### Building and installing amatrix
     18 To install amatrix, use either of the following methods from within the amatrix directory.
     19 
     20 #### Using `configure` (recommended for most linux user)
     21 ```
     22 autoreconf -i  # skip if using released tarball
     23 ./configure
     24 make
     25 make install
     26 ```
     27 
     28 #### Using CMake
     29 Here we also show an out-of-source build in the sub directory "build".
     30 Don't use CMake if you want to use PDCurses, it won't work (for now).
     31 ```
     32 mkdir -p build
     33 cd build
     34 # to install to "/usr/local"
     35 cmake ..
     36 # or to install to "/usr"
     37 #cmake -DCMAKE_INSTALL_PREFIX=/usr ..
     38 make
     39 make install
     40 ```
     41 
     42 ### Running amatrix
     43 After you have installed amatrix just run `amatrix` to run amatrix :)
     44 
     45 _To get the program to look most like the movie, use `amatrix -lba`_
     46 _To get the program to look most like the Win/Mac screensaver, use `amatrix -ol`_
     47 
     48 ### Valuable information
     49 If you have any suggestions/flames/patches to send, please feel free to
     50 open issues and if possible solve them in PRs via Github.
     51 
     52 _Note: amatrix is probably not particularly portable or efficient, but it wont hog
     53 **too** much CPU time_
     54 
     55 ### Captures
     56 
     57 #### Screenshots
     58 
     59 ![Special Font & bold](data/img/capture_bold_font.png?raw=true "amatrix -bx")
     60 
     61 #### Screencasts
     62 
     63 ![Movie-Like Cast](data/img/capture_orig.gif?raw=true "amatrix -xba")
     64 
     65 ### Maintainers
     66 - Abishek V Ashok (@abishekvashok) <abishekvashok@gmail.com> [Core]
     67 
     68 ### Thanks to:
     69 - Chris Allegretta <chrisa@asty.org> for writing amatrix up in a fornight and giving us
     70   the responsibility to further improve it.
     71 - Krisjon Hanson and Bjoern Ganslandt for helping with bold support and 
     72   Bjoern again for the cursor removal code, helping with the `-u` and `-l`
     73   modes/flags, and Makefile improvements.
     74 - Adam Gurno for multi-color support.
     75 - Garrick West for debian consolefont dir support.
     76 - Nemo for design thoughts and continuous help and support.
     77 - John Donahue for helping with transparent term support
     78 - Ben Esacove for Redhat 6 compatibility w/matrix.psf.gz
     79 - jwz for the xmatrix module to xscreensaver at http://www.jwz.org/xscreensaver.
     80 - Chris Allegretta's girlfriend Amy for not killing him when he stayed up till 3 AM
     81   writing code.
     82 - The makers of the Matrix for one kickass movie!
     83 - Everyone who has sent (and who will send) us and Chris mails regarding
     84   bugs, comments, patches or just a hello.
     85 - Everyone who has opened issues and PRs on the github repository.
     86 
     87 ### License
     88 This software is provided under the GNU GPL v3.
     89 
     90 ### Disclaimer
     91 We are in no way affiliated in any way with the movie "The Matrix", "Warner Bros" nor
     92 any of its affiliates in any way, just fans.
     93