summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..4408627
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,40 @@
+RiseupVPN
+=========
+
+Anonymous VPN. Easy, fast, secure.
+
+This repo has everything needed to build RiseupVPN on different platforms
+(windows, mac, linux).
+
+RiseupVPN is a branded build of Bitmask Lite, written in go.
+
+
+Dependencies
+------------
+
+* golang
+* make
+* python (python3, for build scripts)
+
+Dependencies (Windows)
+------------------------
+
+* nsis
+* nssm
+
+Building (Windows)
+------------------
+
+make deps_win
+make openvpn_win
+make build_win
+
+Cross-compiling openvpn for windows
+-----------------------------------
+
+# TODO - modify to build statically and with polarssl.
+
+apt install gcc-mingw-w64-x86-64
+git clone https://github.com/OpenVPN/openvpn-build
+cd openvpn-build/windows-nsis
+CHOST=x86_64-w64-mingw32 CBUILD=i686-pc-cygwin ./build