diff options
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..1919b98 --- /dev/null +++ b/README.rst | |||
@@ -0,0 +1,72 @@ | |||
1 | Editty | ||
2 | ====== | ||
3 | |||
4 | Editty is a terminal-based non-linear editor for terminal recordings. | ||
5 | |||
6 | Installation | ||
7 | ------------ | ||
8 | |||
9 | Source | ||
10 | ~~~~~~ | ||
11 | |||
12 | When installing from source, it is recommended (but not required) to | ||
13 | install Editty in a virtualenv. To set one up:: | ||
14 | |||
15 | virtualenv --python=python3 editty-env | ||
16 | source editty-env/bin/activate | ||
17 | |||
18 | To install the latest version from pypi:: | ||
19 | |||
20 | pip install editty | ||
21 | |||
22 | To install from a git checkout:: | ||
23 | |||
24 | pip install . | ||
25 | |||
26 | In order to use the dissolve transition, you must run Editty in a | ||
27 | 256-color capable terminal, such as gnome-terminal or xterm. | ||
28 | |||
29 | Usage | ||
30 | ----- | ||
31 | |||
32 | After installing Editty, you should be able to run it by invoking | ||
33 | ``editty``. If you installed it in a virtualenv, you can invoke it | ||
34 | without activating the virtualenv with ``/path/to/editty-venv/bin/editty``. | ||
35 | which you may wish to add to your shell aliases. Use ``editty | ||
36 | --help`` to see a list of command line options available. | ||
37 | |||
38 | Once running, pressing the F1 key will show help text. | ||
39 | |||
40 | Editty can load recordings in the formats produced by the ``script`` | ||
41 | and ``ttyrec`` commands. It renders output in ``ttyrec`` format. | ||
42 | |||
43 | Editty does not modify the original source files, but rather | ||
44 | references them by path name. Editty stores the edit decision list in | ||
45 | its own JSON-based file format (use the ``.edit`` extension). | ||
46 | |||
47 | To exit, press CTRL-q. | ||
48 | |||
49 | Source | ||
50 | ------ | ||
51 | |||
52 | Git repo: http://git.inaugust.com/cgit/editty/ | ||
53 | |||
54 | Contributing | ||
55 | ------------ | ||
56 | |||
57 | To send your latest commit as a patch, run:: | ||
58 | |||
59 | git send-email --to corvus@gnu.org --annotate -1 | ||
60 | |||
61 | Or, if you don't have ``git send-email`` configured, run:: | ||
62 | |||
63 | git format-patch --stdout HEAD~1 > /tmp/editty.patch | ||
64 | |||
65 | And send `/tmp/editty.patch` to corvus@gnu.org using your email | ||
66 | client. | ||
67 | |||
68 | License | ||
69 | ------- | ||
70 | |||
71 | Editty is licensed under the GPLv3 or later. Please see the COPYING | ||
72 | file for details. | ||