summaryrefslogtreecommitdiff
path: root/README.md
blob: 389b8e37f61aacbd934099a4be77c67babbebab1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# ted

A text editor.

**ted is still very new, and there are almost certainly bugs. There are also definitely important features missing. I don't recommend using this as your main text editor yet.**

<img src="ted.png">

To install `ted` on Linux, you will need:

- A C compiler
- SDL2
- The GL development libraries

These can be installed on Ubuntu/Debian with:

```
sudo apt install gcc libsdl2-dev libgl-dev
```

Then run

```
sudo make install -j4
```

There is no nice way of installing on Windows yet.

## Why?

There are a lot of text editors out there. ted doesn't do anything new.
But in the modern world of text editors running browsers internally, it can be nice to have
a simple editor that starts up practically instantaneously, and performs well on reasonably-sized files.

## Supported features (more coming soon)

- Multiple tabs, each with a different file
- Auto-indent
- Customization of (pretty much) all colours and keyboard commands.

## Building from source

On Linux, run `make`.

On Windows, you will need the SDL2 VC development libraries: https://www.libsdl.org/download-2.0.php  
Copy SDL2-2.x.y into the ted directory, and rename it to SDL2. Additionally, copy SDL2\lib\x64\SDL2.dll
to the ted directory.  
Then run `make.bat`.

## License

ted is in the public domain (see `LICENSE.txt`).

## Reporting bugs

You can report a bug by sending an email to `pommicket at pommicket.com`.