diff options
| author | Allan Nordhøy <epost@anotheragency.no> | 2020-04-04 04:48:28 +0300 |
|---|---|---|
| committer | Allan Nordhøy <epost@anotheragency.no> | 2020-04-04 04:48:28 +0300 |
| commit | 4e9c0c1be4aa27b11460b4af2d21c938940bae16 (patch) | |
| tree | 4255d6cd9b55ce41b7dd95a581bac23ac1d01431 /README.md | |
| parent | 1b8da53de283b2a4ffb0a1d725977a3d8a8af326 (diff) | |
Contact file replaces CoC and new README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 70 |
1 files changed, 22 insertions, 48 deletions
@@ -3,45 +3,25 @@ [](https://hosted.weblate.org/engage/remmina/?utm_source=widget) [](https://snapcraft.io/remmina) -# IMPORTANT NOTICE +## Remmina remote desktop client -Remmina is now here on [GitLab](https://gitlab.com/Remmina/Remmina) +*Use other desktops remotely, from a tiny screen or large monitors.* -As of the 1st of July 2018, the following links have to be used instead of respective GitHub counterparts. -* [Issues URL](https://gitlab.com/Remmina/Remmina/issues) -* [Wiki URL](https://gitlab.com/Remmina/Remmina/wikis/home) +* RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC network protocols are supported. +* Written in GTK, with a port to Qt underway. +* Released as "remmina" (the main program) and "remmina-plugins". -# Remmina: The GTK Remote Desktop Client +### Installation -Initially developed by [Vic Lee](https://github.com/llyzs). +[How to install Remmina](https://remmina.org/how-to-install-remmina/), +editable on [the wiki](https://gitlab.com/Remmina/Remmina/wikis/home). -## Description -**Remmina** is a remote desktop client written in GTK, aiming to be useful for -system administrators and travellers, who need to work with lots of remote -computers in front of either large or tiny screens. Remmina supports -multiple network protocols, in an integrated and consistent user interface. -Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported. +### Configuration -Remmina is released in separated source packages: -* "remmina", the main GTK application -* "remmina-plugins", a set of plugins +Set up everything from the graphical interface, or from $HOME/.remmina or $HOME/.config/remmina -Remmina is copylefted libre software, licensed GNU GPLv2+. - -## Installation -Instructions for many operating system and building from source to be found [here](https://remmina.org/how-to-install-remmina/), -it can be edited on [the wiki](https://gitlab.com/Remmina/Remmina/wikis/home). - -## Configuration - -You can configure everything from the graphical interface, or editing by hand the files under $HOME/.remmina or $HOME/.config/remmina - -## Contributing - -See [CONTRIBUTING.md](CONTRIBUTING.md) for a better overview. - -If you want to contribute code: +### Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) @@ -49,31 +29,25 @@ If you want to contribute code: 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new merge request -If you want to contribute in other ways, get in contact on IRC (#remmina on freenode), or send an e-mail using the form provided on the website. +There are [other ways](CONTRIBUTING.md) to contribute too, get in contact on IRC (#remmina on freenode), or send an e-mail to the [mailing list](https://lists.remmina.org/listinfo/users). ### Donations -If you want to contribute to Remmina by sending money, you are more than welcome. -More info about this on [Remmina website donation page](https://remmina.org/wp/donations/). - -See the [THANKS.md](THANKS.md) file for a list of all supporters. - -## Authors +This is the website [donation page](https://remmina.org/wp/donations/). +[THANKS](THANKS.md) is a list of supporters. -Remmina is maintained by: +### Authors - * [Antenore Gatta](https://gitlab.com/antenore) - * [Giovanni Panozzo](https://gitlab.com/giox069) - * [Dario Cavedon](https://gitlab.com/ic3d) +Maintained by [Antenore Gatta](https://gitlab.com/antenore), [Giovanni Panozzo](https://gitlab.com/giox069) and [Dario Cavedon](https://gitlab.com/ic3d). +Add yourself in [AUTHORS](AUTHORS) if you have contributed. -See the [AUTHORS](AUTHORS) for an exhaustive list. -If you are not listed and have contributed, feel free to update it. - -## Resources +### Resources * [Website](https://www.remmina.org/) * IRC room on freenode.net, in the #remmina channel, you can also use a [web client](https://kiwiirc.com/client/irc.freenode.net/?nick=remminer|?#remmina/). -## License +### License + +Copylefted libre software, licensed [GPLv2+](https://gitlab.com/Remmina/Remmina/blob/master/COPYING). -Licensed [GPLv2+](https://gitlab.com/Remmina/Remmina/blob/master/COPYING).
\ No newline at end of file +Initially developed by [Vic Lee](https://github.com/llyzs).
\ No newline at end of file |