N0VA/BeamMeUp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
N0VA
2026-01-04 19:28:46 +01:00
parent dabb2e66b6
commit e513c5e4f2
1 changed files with 17 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@@ -1,50 +1,28 @@
# Teleport
Teleport is a native GTK3 app to effortlessly share files on the local network.
<img src="data/icons/hicolor/org.nekoweb.n0va.BeamMeUp.svg" width="128" height="128" align="center">
![Screenshot of the Teleport application window](docs/screenshots/window.png)
# BeamMeUp
BeamMeUp is a native GTK4 application to effortlessly share files on the local network. It's based on [teleport](https://gitlab.gnome.org/jsparber/teleport) by Julian Sparber
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?
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:
BeamMeUp 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:
![Screenshot of a Teleport notification](docs/screenshots/notification.png)
![Screenshot of a notification](docs/screenshots/notification.png)
## Install
Teleport is currently in early development, but you can try it by installing it
via GNOME Software or via [flatpak](http://flatpak.org).
```
flatpak install flathub com.frac_tion.teleport
```
## Features
* **Simple:** Just drag and drop files to send them.
* **Native:** Integrated with GNOME notifications and system styling.
* **Fast:** Direct peer-to-peer transfers over your local network.
## Roadmap
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
* sending text snippets
* file transfer progress bars
* encryption in transit
* native Android/iOS/macOS/Windows apps
## Building from source
To build BeamMeUp, you'll need `gtk4`, `libadwaita`, `libsoup-2.4`, and `avahi` development headers.
## Build
#### Archlinux
```bash
./configure
make
sudo make install
```
pacman -S base-devel libsoup avahi gtk3 meson
git clone https://gitlab.gnome.org/jsparber/teleport
cd teleport
./configure
sudo make install
teleport # or ./_build/src/teleport
```
#### Ubuntu
```
apt install pkg-config libsoup2.4-dev libavahi-client3 libavahi-client-dev libgtk-3-dev meson
git clone https://gitlab.gnome.org/jsparber/teleport
cd teleport
./configure
make
sudo make install
teleport # or ./_build/src/teleport
```
## License
AGPLv3, because freeeeeeedom
AGPLv3