Skip to content

Commit 9b37b6f

Browse files
committed
Removed some documentation...
1 parent e07a703 commit 9b37b6f

1 file changed

Lines changed: 9 additions & 65 deletions

File tree

README.md

Lines changed: 9 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -4,82 +4,26 @@
44

55
## python-scrolltext
66

7-
### Plain Terminal version
8-
9-
SCROLL_TEXT="Hello, world." scrolltext
10-
11-
You can select the line via `SCROLL_LINE` variable. Negative values are counting
12-
from bottom to top, e.g. the following selects the 2nd last line in the current
13-
terminal:
14-
15-
SCROLL_TEXT="Hello, world." SCROLL_LINE=-2 scrolltext
7+
A little toy-like app for scrolling text in your favourite terminal.
168

9+
There is a configuration file "~/.config/scrolltextrc" on UNIX systems and just scrolltextrc in the
10+
current directory when you are using it on a WINDOWS machine. If the config file is not yet
11+
existing, it can be created by passing the command line option: "-w"|"--write", like so:
1712

18-
### Curses Version
19-
20-
SCROLL_TEXT="Hello, world." scrolltext cursestext
21-
22-
In addition to `SCROLL_TEXT` and `SCROLL_LINE` variables, the submodule cursestext
23-
understands the variables `VERBOSE` and `SCROLL_BOX`.
13+
scrolltext -w
2414

25-
Setting `VERBOSE=1` will create a logfile: 'cursesscroller.log' in the
26-
current directory.
2715

28-
Here is an example:
29-
30-
SCROLL_BOX=1 SCROLL_LINE=-1 VERBOSE=1 scrolltext cursestext
31-
32-
The box is enabled by default.
16+
### Plain Terminal version
3317

34-
In order to not draw the box, you can switch it off by defining the variable
35-
`SCROLL_TEXT` with an empty value or 0, e.g. use
18+
SCROLL_TEXT="Hello, world." scrolltext [linescroller]
3619

37-
SCROLL_BOX= SCROLL_LINE=-1 scrolltext cursestext
3820

39-
or
21+
### Curses Version
4022

41-
SCROLL_BOX=0 SCROLL_LINE=-1 scrolltext cursestext
23+
SCROLL_TEXT="Hello, world." scrolltext cursestext
4224

4325

4426
### Scroll right-to-left reading text
4527

4628
Using `SCROLL_DIRECTION=1` makes the text start scrolling from left-side of the terminal.
4729
This is used for right-to-left writing languages.
48-
49-
50-
### Using a different scrolling speed
51-
52-
The scrolling speed can be altered by setting the environment variable `SCROLL_SPEED`
53-
There are 10 different speeds available. These can be selected by choosing a
54-
number between 0 and 9.
55-
56-
Slow scrolling speed (default, if not set)
57-
58-
SCROLL_SPEED=0 scrolltext
59-
60-
61-
Fastest scrolling speed.
62-
63-
SCROLL_SPEED=10 scrolltext
64-
65-
66-
## Bugs and quirks
67-
68-
- attempts to detect term-resize, and clumsily adjusts some things
69-
- no colors
70-
71-
72-
## Changes
73-
74-
### v0.0.9
75-
76-
- attempt to handle term resizes
77-
- added config-option: endless (see newly generated config-file)
78-
- removed logging from main branch (you may find it on the devel branch)
79-
80-
### v0.0.8
81-
82-
- doc-comments have never been generated, nor are those validated. (TODO)
83-
- renamed log-file to "scrolltext.log"
84-
- uses config file "scrolltextrc"
85-
\*NIX uses "~/.config/scrolltextrc", windows uses "scrolltextrc" in current directory

0 commit comments

Comments
 (0)