summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSlávek Banko <[email protected]>2021-10-19 13:07:36 +0200
committerSlávek Banko <[email protected]>2021-10-19 13:07:36 +0200
commite29ddc47b89c8ebb605b8a26a80191940c1de640 (patch)
treed180e36e69a3b9f7ab7f50170a8309b8a51aa686 /README.md
parent829fc9f284998573833bc6a87fe14e33faf4dca3 (diff)
downloadkvpnc-e29ddc47b89c8ebb605b8a26a80191940c1de640.tar.gz
kvpnc-e29ddc47b89c8ebb605b8a26a80191940c1de640.zip
Change README to markdown format.
Add translation status overview. Signed-off-by: Slávek Banko <[email protected]>
Diffstat (limited to 'README.md')
-rw-r--r--README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..285fe1a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+
+ KVpnc - a TDE frontend for various vpn clients
+
+
+It supports:
+------------
+
+* Cisco-compatible VPN client (vpnc)
+* IPSec (freeswan, openswan, racoon)
+* Point-to-Point Tunneling Protocol (PPTP) client (pptp-linux)
+* Virtual Private Network daemon (openvpn)
+
+
+Features include:
+-----------------
+
+- easy to use KDE gui
+- docking in kicker
+- localized GUI (Bulgarian, Chinese, Dutch, French, German, Hungarian,
+ Italian, Slovak, Polish, Portuguese Brazilian, Russian,
+ Spanish)
+- VPN connection to Cisco concentrator
+- VPN connection to VPN servers by using IPsec
+ - FreeS/WAN (Linux 2.4.x) support
+ - racoon (Linux 2.6.x/BSD) support
+- PPTP support (pptpclient)
+- OpenVPN support
+- Multiple profiles
+- preshared secret support
+- X509 certificate support
+- Cisco PCF file import
+- PKCS12 certificate import
+- Ping test
+- automaticlly setting of routes and firewall rules (iptables) (currently: freeswan/racoon)
+- automaticlly network device detection (can be overridden)
+- log file writing
+- DCOP interface
+- user notification for sucessful connect/disconnect
+- NAT-T support (racoon/OpenVPN/vpnc)
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to kvpnc, you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/weblate
+
+
+Translations status
+---------------------
+
+### messages
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kvpnc/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kvpnc/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kvpnc-kvpncdesktop/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kvpnc-kvpncdesktop/)
+
+### events
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kvpnc-events/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kvpnc-events/)