Skip to content

Commit

Permalink
Add README.md, screenshot, and .gitignore.
Browse files Browse the repository at this point in the history
  • Loading branch information
evangreen committed Sep 27, 2017
1 parent db7b456 commit eebbbe8
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.rsc
*.o
*.scr
Binary file added Phosphor2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Phosphor 2
This project is a Windows screensaver based on the original Phosphor xscreensaver by Jamie Zawinski.

![Screenshot](Phosphor2.jpg)

### Installation Instructions
Installation is easy. Simply download the binary from the Downloads page, right click it, and select Install. Right click and select Test if you'd like to see it without installing it.

### What is this?
Phosphor2 is a screensaver that creates the appearance of the old "Green Screen" terminals. It will print out the contents of a list of files or directories provided by you, enumerated randomly, or print out the source code for the screensaver itself by default.

### Configuration
Configuration should be fairly straightforward, and includes options for changing the foreground color, background color, cursor blink rate, text rate, text size, and text fade rate. The only slightly tricky box is the Files box, and it's not even that hard. The files box takes a semicolon-delimited list of files, potentially with wildcards. Wildcards are recursive meaning that if you specify a wildcard, it includes the file pattern in that directory and any subdirectories.

Let's do an example. The following prints out any files that end in .c or .h from the directory `c:\\src` or any of its child directories, as well as one individual called Makefile. Files are chosen at random from the list. `c:\\src\\*.c;c:\\src\\*.h;c:\\src\\Makefile`

If you specify nothing or no valid files, the source files of the screensaver itself will be printed to the screen to keep you occupied. Feel free to point out bugs!

### License
GPLv3

0 comments on commit eebbbe8

Please sign in to comment.