TextRoom v0.5.4
http://code.google.com/p/textroom/


(c) by Omer Bahri Gordebak 2008 <gordebak at gmail dot com>
released under terms of GNU General Public License v3

(c) by Petar Toushkov 2008 <peter dot toushkov at gmail dot com>
released under terms of GNU General Public License v3

Parts of this program's code are from the Phrasis project:

http://code.google.com/p/phrasis/

and are

Copyright (C) 2006 Jacob R Rideout <jacob@jacobrideout.net>

Code, artwork, help and insights by:
adamvert - from http://ubuntuforums.org/
Donny Lim - <donnylucky at gmail dot com>
Magnus Edvardsson (a.k.a. zebulon M) - from http://ubuntuforums.org/


1. Introduction
---------------

TextRoom is a pretty basic full-screen text editor, heavily inspired
by similar text editors such as Q10, JDarkRoom and so on.

2. Requirements
---------------
TextRoom requires Qt library version >=4.3.2.
It *may* work with earlier versions of Qt (from 4.x family), but it was not
tested.

3. Installation
---------------
To compile TextRoom, you will need Qt4 development packages
(usually named -devel- or -dev in some distros). Cd to the directory
this README file is. Compilation includes three steps:

qmake-qt4
make

and then, as root:

make install

"make install" copies the newly compiled "bin/textroom" to "/usr/local/bin".
You can change its path by editing textroom.pro

The program stores its preferences in ~/.config/textroom/TextRoom.conf

4. Features

  * configurable colors and fonts
  * configurable behavior: full-screen on/off, auto save, flow mode (disable delete and backspace keys), load last document on startup, remember position in text for the last file, horizontal progress slider
  * display current time and date, some statistics
  * keyboard shortcuts for the most common tasks (if you start the program for the first time, just press F1 for help)

5. How to use TextRoom
----------------------

Keyboard shortcuts:

F1 - Help screen
F11 - Fullscreen on/off
Escape - Quit or exit fullscreen (depends on current active window state)
Ctrl+H - About
Ctrl+M - Minimize TextRoom
Ctrl+Q - Quit

Ctrl+N - New
Ctrl+O - Open
Ctrl+S - Save
Ctrl+Shift+S - Save As

Ctrl+X - Cut
Ctrl+C - Copy
Ctrl+V - Paste
Ctrl+A - Select All
Ctrl+Z - Undo (Ctrl+Shift+Z to Redo)
Ctrl+T - Indent first lines (useful due to unresolved bug)
Shift+F4 - Go back to cursor position
Ctrl+F - Find
F3 - Find Next
Shift+F3 - Find previous

Ctrl+D - Insert Date
Ctrl+L - Insert Date
Ctrl+U - Options

You can get some additional information on your current file
by placing the mouse pointer over its name or statistics in the
statusbar (right and left lower corners of the screen).