README.md 1.65 KB
Newer Older
Tobias Bernard's avatar
Tobias Bernard committed
1
2
# Teleport
Teleport is a native GTK3 app to effortlessly share files on the local network.
Julian Sparber's avatar
Julian Sparber committed
3

4
![Screenshot of the Teleport application window](docs/screenshots/window.png)
Julian Sparber's avatar
Julian Sparber committed
5

6
Have you ever asked yourself why the easiest way to move a file between two computers in the same room involves sending it to a server in another country?
Julian Sparber's avatar
Julian Sparber committed
7

Tobias Bernard's avatar
Tobias Bernard committed
8
9
Teleport is designed to be a replacement for using USB keys or emailing stuff to yourself just so you have them on another device on your desk. The main user interface on the receiver's side are notifications:

10
![Screenshot of a Teleport notification](docs/screenshots/notification.png)
Tobias Bernard's avatar
Tobias Bernard committed
11

12
## Install
13
14
Teleport is currently in early development, but you can try it by installing it
via GNOME Software or via [flatpak](http://flatpak.org).
15
```
16
flatpak install flathub com.frac_tion.teleport
17
18
```

Tobias Bernard's avatar
Tobias Bernard committed
19
## Roadmap
20
21
It's still early days, but we have exciting plans for the future. While Teleport can currently only send individual files, longer term we are interested in doing things like:
* sending multiple files and folders
Tobias Bernard's avatar
Tobias Bernard committed
22
23
* sending text snippets
* file transfer progress bars
24
* encryption in transit
Tobias Bernard's avatar
Tobias Bernard committed
25
26
27
* native Android/iOS/macOS/Windows apps

## Build
Julian Sparber's avatar
Julian Sparber committed
28
#### Archlinux
Julian Sparber's avatar
Julian Sparber committed
29
```
30
  pacman -S base-devel libsoup avahi gtk3 meson
Thibault Martin's avatar
Thibault Martin committed
31
  git clone https://gitlab.gnome.org/jsparber/teleport
32
33
  cd teleport
  ./configure
34
35
  sudo make install
  teleport # or ./_build/src/teleport
Julian Sparber's avatar
Julian Sparber committed
36
```
Julian Sparber's avatar
Julian Sparber committed
37
#### Ubuntu
38
```
39
  apt install pkg-config libsoup2.4-dev libavahi-client3 libavahi-client-dev libgtk-3-dev meson
Thibault Martin's avatar
Thibault Martin committed
40
  git clone https://gitlab.gnome.org/jsparber/teleport
41
42
  cd teleport
  ./configure
43
  make
44
45
  sudo make install
  teleport # or ./_build/src/teleport
46
47
```

Tobias Bernard's avatar
Tobias Bernard committed
48
49
50

## License
AGPLv3, because freeeeeeedom