Skip to content

Commit f0a5921

Browse files
author
Anand
committed
Updated README for binary install
1 parent d622573 commit f0a5921

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Table of Contents
77

88
* [About](#about)
99
* [Why a rewrite](#why-a-rewrite)
10-
* [Building the code](#building-the-code)
10+
* [Install](#install)
1111
* [Usage](#usage)
1212
* [Encryption and Security](#encryption-and-security)
1313
* [Databases](#databases)
@@ -37,8 +37,18 @@ If you ask - `"Why a rewrite, why not contribute to the original repo ?"`, it is
3737
4. C is a venerable language but this is 2021 and I would rather program (and contribute) in a modern system programming language like `Go` or `Rust` which takes care of the memory handling tasks and leaves me to focus on the application code. Also I felt it is easier to get contributors to a project if it is in one of these languages as a lot of the Gen Z programmers don't know C. You will appreciate this more if you look at an open source repo written in C/C++ and find that 30% of all code are operations allocating/de-allocating memory.
3838
5. Support for more ciphers and crypto systems - `Varuh` already supports the `XChacha20-Poly1305` stream cipher and uses `Argon2` (Argon2i variant) instead of the older `pbkdf2` as the key derivation function. OpenPGP encryption is in the pipeline.
3939

40-
Building the code
41-
=================
40+
Install
41+
=======
42+
43+
## Binary Release
44+
45+
If you are on a Debian or Debian derived system, you can directly download and install the 0.1 version. Check out the [releases](https://github.com/pythonhacker/varuh/releases) page and use `dpkg` to install the binary.
46+
47+
$ sudo dpkg -i varuh-${VERSION}_amd64.deb
48+
49+
The binary will be installed in `/usr/bin` folder.
50+
51+
## Building from Source
4252

4353
You need the [Go compiler](https://golang.org/dl/) to build the code. (This can be usually installed on \*nix machines by the native package managers like *apt-get*).
4454

0 commit comments

Comments
 (0)