Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
bitmask-vpn
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Vladimir KozLove
bitmask-vpn
Commits
3a563a8a
Unverified
Commit
3a563a8a
authored
4 years ago
by
Kali Kaneko
Browse files
Options
Downloads
Patches
Plain Diff
[docs] streamline readme
parent
4573c135
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+16
-26
16 additions, 26 deletions
README.md
with
16 additions
and
26 deletions
README.md
+
16
−
26
View file @
3a563a8a
Build
-----
Install dependencies:
```
sudo make depends
```
Build the application:
Clone this repo, install dependencies and build the application. Dependencies
assume debian packages, or homebrew for osx. For other systems try
manually, or send us a patch.
```
git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
sudo make depends
make build
```
...
...
@@ -22,21 +19,11 @@ You need at least go 1.11. If you have something older and are using ubuntu, you
For other situations, have a look at https://github.com/golang/go/wiki/Ubuntu or https://golang.org/dl/
OSX
---
You can install dependencies with homebrew:
```
git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
make depends
make build
```
Test
----
You can run some tests too.
```
sudo apt install qml-module-qttest
make test
...
...
@@ -50,15 +37,18 @@ Translations
We use
[
transifex
](
https://www.transifex.com/otf/bitmask/RiseupVPN/
)
to coordinate translations. Any help is welcome!
Bugs?
-----
Bugs?
Crashes? UI feedback? Any other suggestions or complains?
-----
----------------------------------------------------------
When you report an issue include the following information:
When you are willing to
[
report an issue
](
https://0xacab.org/leap/bitmask-vpn/-/issues
)
please
use the search tool first. if you cannot find your issue, please make sure to
include the following information:
*
what you expected to see
*
what you got
*
the version of the program. You can check the version on the about page.
*
the platform you're using and the installation method.
*
the version of the program. You can check the version on the "about" menu.
*
what you expected to see.
*
what you got instead.
*
the logs of the program. The location of the logs depends on the OS:
*
linux:
`/home/<your user>/.config/leap/systray.log`
*
gnu/
linux:
`/home/<your user>/.config/leap/systray.log`
*
OSX:
`/Users/<your user>/Library/Preferences/leap/systray.log`
,
`/Applications/RiseupVPN.app/Contents/helper/helper.log`
&
`/Applications/RiseupVPN.app/Contents/helper/openvpn.log`
*
windows:
`C:\Users\<your user>\AppData\Local\leap\systray.log`
,
`C:\Program Files\RiseupVPN\helper.log`
&
`C:\Program Files\RiseupVPN\openvp.log`
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment