A bit synchronization with master branch

TeaVPN2-0.0.1-rc1

			Notes for TeaVPN2-0.0.1-rc1
Good day!

@@ Short Intro
I am happy to announce that this is the first release candidate version of
TeaVPN2. TeaVPN2 is a free VPN software, current supported platform is only
Linux. I plan to expand to other plaforms too, but that is not my priority
right now.

Once you compile it, you will have a single binary named teavpn2. It contains
VPN server and VPN client (both are in single binary).

What features does it have?
- IPv4 tunnel.
- Forward default route traffic to VPN server.
- Multiple clients (but can't communicate client-to-client yet).

@@ Apologies
This is not a secure and stable VPN software yet. I haven't even implemented
encryption yet. Anyone who hoped for that will have to wait for the first
stable release (1.0).

I am going to implement multithreading and encryption in the near future. That
is my priority for this project right now. Anyone with questions or
suggestions (even bug-reports if you decide to get it working on your system)
is encouraged to chat or mail me.

@@ Contributing
This project is open source and licensed under GNU GPL-v2 license. I need
project contributors who understand programming in C and Linux kernel. And of
course those who have interest in contributing to open source software.

@@ Getting it working
The build is very simple, you need to have at least GCC 9.3+ and GNU make.

	git clone https://github.com/TeaInside/teavpn2
	cd teavpn2
	make RELEASE_MODE=1 -j4

	# This should be run on your VPN server
	./teavpn2 server -c your_server_config.ini

	# This should be run on your local machine
	./teavpn2 client -c your_client_config.ini

Remove the RELEASE_MODE=1 to get debug version.

You can see the config examples in `config` directory. I think it's clear
what to do with that :)

Happy hacking!

Ammar Faizi
[email protected]