Corrected go get command examples

[gogost.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 5f1d9264dd7b90cad772d61c61121bee05ba6bed..bf0b19cda674623f50ca1656809427b89db2a265 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,17 +1,49 @@
 Preferable way is to download tarball with the signature from official
 website and, for example, run tests with benchmarks:
 
 Preferable way is to download tarball with the signature from official
 website and, for example, run tests with benchmarks:
 

-    % wget http://www.cypherpunks.ru/gogost/gogost-1.0.tar.xz
-    % wget http://www.cypherpunks.ru/gogost/gogost-1.0.tar.xz.sig
-    % gpg --verify gogost-1.0.tar.xz.sig gogost-1.0.tar.xz
-    % xz -d < gogost-1.0.tar.gz | tar xf -
-    % make -C gogost-1.0 bench
+    $ wget http://gogost.cypherpunks.ru/gogost-4.1.0.tar.xz
+    $ wget http://gogost.cypherpunks.ru/gogost-4.1.0.tar.xz.sig
+    $ gpg --verify gogost-4.1.0.tar.xz.sig gogost-4.1.0.tar.xz
+    $ xz -d < gogost-4.1.0.tar.xz | tar xf -
+    $ make -C gogost-4.1.0 all bench
+    $ echo hello world | ./gogost-4.1.0/streebog256
+    f72018189a5cfb803dbe1f2149cf554c40093d8e7f81c21e08ac5bcd09d9934d
+
+And then you can include its source code in your project for example
+like this:
+
+    $ mkdir -p myproj/src
+    $ cp -r gogost-4.1.0/src/go.cypherpunks.ru myproj/src
+    $ export GOPATH=$PWD/myproj
+    $ cd myproj/src
+    $ cat > main.go <<EOF
+    package main
+
+    import (
+        "encoding/hex"
+        "fmt"
+
+        "go.cypherpunks.ru/gogost/v4/gost34112012256"
+    )
+
+    func main() {
+        h := gost34112012256.New()
+        h.Write([]byte("hello world"))
+        fmt.Println(hex.EncodeToString(h.Sum(nil)))
+    }
+    EOF
+    $ go run main.go
+    c600fd9dd049cf8abd2f5b32e840d2cb0e41ea44de1c155dcd88dc84fe58a855
+
+GoGOST is also go-get-able. For example to use streebog256 utility:
+
+    $ go get go.cypherpunks.ru/gogost/cmd/streebog256

 
 You have to verify downloaded tarballs integrity and authenticity to be
 sure that you retrieved trusted and untampered software. GNU Privacy
 Guard is used for that purpose.
 
 
 You have to verify downloaded tarballs integrity and authenticity to be
 sure that you retrieved trusted and untampered software. GNU Privacy
 Guard is used for that purpose.
 

-For the very first time it it necessary to get signing public key and
+For the very first time it is necessary to get signing public key and

 import it. It is provided below, but you should check alternative
 resources.
 
 import it. It is provided below, but you should check alternative
 resources.
 


@@ -20,7 +52,5 @@ resources.
     uid   GoGOST releases <gogost at cypherpunks dot ru>
 
     Look in PUBKEY.asc file.
     uid   GoGOST releases <gogost at cypherpunks dot ru>
 
     Look in PUBKEY.asc file.

-    % gpg --keyserver hkp://keys.gnupg.net/ --recv-keys 0x82343436696FC85A
-    % gpg --auto-key-locate dane --locate-keys gogost at cypherpunks dot ru
-    % gpg --auto-key-locate wkd --locate-keys gogost at cypherpunks dot ru
-    % gpg --auto-key-locate pka --locate-keys gogost at cypherpunks dot ru
+    $ gpg --auto-key-locate dane --locate-keys gogost at cypherpunks dot ru
+    $ gpg --auto-key-locate wkd --locate-keys gogost at cypherpunks dot ru