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