26
by Bruno Bord
Adding README, as a simple dump of the wiki page. |
1 |
====== PyRoom Project ====== |
2 |
||
3 |
PyRoom is a fullscreen simple text editor, without a toolbar, a menubar or anything that would distract the user from his most important task: writing. |
|
4 |
||
5 |
===== Dependencies ===== |
|
6 |
||
7 |
PyRoom depends on Python, PyGTK and gtksourceview. Please refer to your system documentation for information on how to install these modules if they're not currently available. |
|
8 |
||
9 |
===== Installing and Running ===== |
|
10 |
||
50.1.37
by Florian Heinle
changed README to comply with new method of installation and invocation |
11 |
PyRoom is available as a seutptools enabled package. Installation procedures for those are easy: |
12 |
||
13 |
Either unpack the tarball |
|
14 |
||
15 |
$ tar xvfz pyroom.tar.gz |
|
16 |
||
17 |
or check out our bazaar branch for a development version (we try to keep those |
|
18 |
unbroken and ready for production use) |
|
19 |
||
20 |
$ bzr branch lp:pyroom |
|
21 |
||
22 |
From there, you can either run pyroom from commandline |
|
23 |
||
24 |
$ cd pyroom/ |
|
25 |
$ ./pyroom |
|
26 |
||
27 |
Or install it system wide |
|
28 |
||
29 |
$ cd pyroom |
|
30 |
$ python setup.py install # as root |
|
31 |
$ pyroom |
|
26
by Bruno Bord
Adding README, as a simple dump of the wiki page. |
32 |
|
33 |
==== Usage ==== |
|
34 |
||
35 |
=== Running PyRoom === |
|
36 |
||
37 |
To run pyroom and instruct it to load some existing files, type: |
|
38 |
||
50.1.37
by Florian Heinle
changed README to comply with new method of installation and invocation |
39 |
$ pyroom /path/to/file1 /other/path/to/file2 |
26
by Bruno Bord
Adding README, as a simple dump of the wiki page. |
40 |
|
41 |
===Graphical Styles=== |
|
42 |
||
43 |
The default style is "green", which is a green text color in a black background. You can change the chosen style by typing: |
|
44 |
||
50.1.37
by Florian Heinle
changed README to comply with new method of installation and invocation |
45 |
$ pyroom [--style={style name}] |
26
by Bruno Bord
Adding README, as a simple dump of the wiki page. |
46 |
|
47 |
For instance: |
|
48 |
||
50.1.37
by Florian Heinle
changed README to comply with new method of installation and invocation |
49 |
$ pyroom --style=blue |
26
by Bruno Bord
Adding README, as a simple dump of the wiki page. |
50 |
|
51 |
At the time of writing, the available styles are: |
|
52 |
* blue |
|
53 |
* green |
|
54 |
* darkgreen |
|
55 |
||
56 |
=== Example Usage === |
|
57 |
||
58 |
For example, to load PyRoom and instruct it to use the "darkgreen" style and to load the files "article.txt" and "blogpost.txt", type the following: |
|
59 |
||
50.1.37
by Florian Heinle
changed README to comply with new method of installation and invocation |
60 |
$ pyroom --style=darkgreen article.txt blog.txt |
26
by Bruno Bord
Adding README, as a simple dump of the wiki page. |
61 |
|
62 |
==== Key Bindings ==== |
|
63 |
||
64 |
There are a few keys allowing you to perform a few useful commands: |
|
65 |
||
66 |
* Control-H: Show help in a new buffer |
|
67 |
* Control-I: Show buffer information |
|
68 |
* Control-L: Toggle line number |
|
69 |
* Control-N: Create a new buffer |
|
70 |
* Control-O: Open a file in a new buffer |
|
71 |
* Control-Q: Quit |
|
72 |
* Control-S: Save current buffer |
|
73 |
* Control-Shift-S: Save current buffer as |
|
74 |
* Control-W: Close buffer and exit if it was the last buffer |
|
75 |
* Control-Y: Redo last typing |
|
76 |
* Control-Z: Undo last typing |
|
77 |
* Control-Page Up: Switch to previous buffer |
|
78 |
* Control-Page Down: Switch to next buffer |
|
79 |
* Control-Plus: Increases font size |
|
80 |
* Control-Minus: Decreases font size |
|
81 |
||
82 |
===== Want to know more? ===== |
|
83 |
||
84 |
* Pyroom Website: http://pyroom.org |
|
85 |
* Pyroom project page on Launchpad: https://launchpad.net/pyroom |
|
86 |
* Pyroom Wiki: http://wiki.pyroom.org/doku.php |