Commit 68d85af0 authored by squbs's avatar squbs

post swap readme update

parent 04900a5e
This diff is collapsed.
Straks Core 1.14.5
================
STRAKS
======
##### Copyright (c) 2009-2017 Straks Developers
##### Copyright (c) 2009-2017 STRAKS Developers
##### Copyright (c) 2014-2015 Dash Developers
##### Copyright (c) 2017 Straks Developers
##### Copyright (c) 2017-2018 STRAKS Developers
Setup
---------------------
[Straks Core](https://github.com/squbs/straks/releases) is the original Straks client and it builds the backbone of the network. However, it downloads and stores the entire history of Straks transactions (which is currently several GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more. Thankfully you only have to do this once. If you would like the process to go faster you can [download the blockchain directly](bootstrap.md).
Running
---------------------
The following are some helpful notes on how to run Straks on your native platform.
### Unix
You need the Qt4 run-time libraries to run Straks-Qt. On Debian or Ubuntu:
sudo apt-get install libqtgui4
Unpack the files into a directory and run:
- bin/32/straks-qt (GUI, 32-bit) or bin/32/straksd (headless, 32-bit)
- bin/64/straks-qt (GUI, 64-bit) or bin/64/straksd (headless, 64-bit)
### Windows
Unpack the files into a directory, and then run straks-qt.exe.
### OSX
Drag Straks-Qt to your applications folder, and then run Straks-Qt.
[STRAKS Core](https://github.com/squbs/straks/releases) is the original STRAKS client and it builds the backbone of the network. However, it downloads and stores the entire history of STRAKS transactions; depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few minutes to hours or a day or more. Thankfully you only have to do this once.
### Need Help?
* See the documentation at the [bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
* See the documentation at the [STRAKS Knowledge Base](https://kb.straks.info)
for help and more information.
* Ask for help on [#bitcoin](http://webchat.freenode.net?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=bitcoin).
* Ask for help on the [bitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).
* Ask for help on [STRAKS Discord](https://discord.gg/5gzvadZ)
Building
---------------------
The following are developer notes on how to build Straks on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
The following are developer notes on how to build STRAKS on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
- [OSX Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-msw.md)
Development
---------------------
The Straks repo's [root README](https://github.com/squbs/Straks) contains relevant information on the development process and automated testing.
- [Coding Guidelines](coding.md)
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
- [Translation Process](translation_process.md)
- [Unit Tests](unit-tests.md)
### Resources
* Discuss on the [bitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
* Discuss on [#bitcoin-dev](http://webchat.freenode.net/?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-dev).
### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [Files](files.md)
- [Tor Support](tor.md)
License
---------------------
Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
......
Straks Core 1.14.5.0
=====================
STRAKS
======
Intro
-----
Straks is a free open source peer-to-peer electronic cash system that is
STRAKS is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending.
......@@ -13,11 +13,11 @@ Setup
-----
Unpack the files into a directory and run straks-qt.exe.
Straks Core is the original Straks client and it builds the backbone of the network.
However, it downloads and stores the entire history of Straks transactions;
STRAKS Core is the original STRAKS client and it builds the backbone of the network.
However, it downloads and stores the entire history of STRAKS transactions;
depending on the speed of your computer and network connection, the synchronization
process should take only a few hours.
See the official website:
http://www.straks.io/
https://straks.io/
for more iormation and help.
Straks Core 1.14.5
=====================
STRAKS
======
Intro
-----
Straks is a free open source peer-to-peer electronic cash system that is
STRAKS is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending.
......@@ -13,8 +13,8 @@ Setup
-----
Unpack the files into a directory and run straks-qt.exe.
Straks Core is the original Straks client and it builds the backbone of the network.
However, it downloads and stores the entire history of Straks transactions;
STRAKS Core is the original STRAKS client and it builds the backbone of the network.
However, it downloads and stores the entire history of STRAKS transactions;
depending on the speed of your computer and network connection, the synchronization
process should take only a few hours.
......
Benchmarking
============
Straks Core has an internal benchmarking framework, with benchmarks
STRAKS has an internal benchmarking framework, with benchmarks
for cryptographic algorithms such as SHA1, SHA256, SHA512 and RIPEMD160. As well as the rolling bloom filter.
After compiling straks-core, the benchmarks can be run with:
......
WINDOWS BUILD NOTES
===================
For example following command adds user execute permission to an arbitrary file:
git update-index --chmod=+x <file>
Compilers Supported
-------------------
TODO: What works?
Note: releases are cross-compiled using mingw running on Linux.
Dependencies
------------
Libraries you need to download separately and build:
name default path download
--------------------------------------------------------------------------------------------------------------------
OpenSSL \openssl-1.0.1c-mgw http://www.openssl.org/source/
Berkeley DB \db-4.8.30.NC-mgw http://www.oracle.com/technology/software/products/berkeley-db/index.html
Boost \boost-1.50.0-mgw http://www.boost.org/users/download/
miniupnpc \miniupnpc-1.6-mgw http://miniupnp.tuxfamily.org/files/
Their licenses:
OpenSSL Old BSD license with the problematic advertising requirement
Berkeley DB New BSD license with additional requirement that linked software must be free open source
Boost MIT-like license
miniupnpc New (3-clause) BSD license
Versions used in this release:
OpenSSL 1.0.1c
Berkeley DB 4.8.30.NC
Boost 1.50.0
miniupnpc 1.6
OpenSSL
-------
MSYS shell:
un-tar sources with MSYS 'tar xfz' to avoid issue with symlinks (OpenSSL ticket 2377)
change 'MAKE' env. variable from 'C:\MinGW32\bin\mingw32-make.exe' to '/c/MinGW32/bin/mingw32-make.exe'
cd /c/openssl-1.0.1c-mgw
./config
make
Berkeley DB
-----------
MSYS shell:
cd /c/db-4.8.30.NC-mgw/build_unix
sh ../dist/configure --enable-mingw --enable-cxx
make
Boost
-----
MSYS shell:
downloaded boost jam 3.1.18
cd \boost-1.50.0-mgw
bjam toolset=gcc --build-type=complete stage
MiniUPnPc
---------
UPnP support is optional, make with `USE_UPNP=` to disable it.
MSYS shell:
cd /c/miniupnpc-1.6-mgw
make -f Makefile.mingw
mkdir miniupnpc
cp *.h miniupnpc/
Straks
-------
MSYS shell:
cd \straks
sh autogen.sh
sh configure
mingw32-make
strip straks.exe
------------------- compiling straks on windows
./autogen.sh
CPPFLAGS="-I/c/deps/db-4.8.30.NC/build_unix \
-I/c/deps/openssl-1.0.2/include \
-I/c/deps \
-I/c/deps/protobuf-2.5.0/src \
-I/c/deps/libpng-1.6.14 \
-I/c/deps/qrencode-3.4.4" \
LDFLAGS="-L/c/deps/db-4.8.30.NC/build_unix \
-L/c/deps/openssl-1.0.2 \
-L/c/deps/miniupnpc \
-L/c/deps/protobuf-2.5.0/src/.libs \
-L/c/deps/libpng-1.6.14/.libs \
-L/c/deps/qrencode-3.4.4/.libs" \
BOOST_ROOT=/c/deps/boost_1_55_0 \
./configure \
--with-qt-incdir=/c/Qt/5.3.2/include \
--with-qt-libdir=/c/Qt/5.3.2/lib \
--with-qt-plugindir=/c/Qt/5.3.2/plugins \
--with-qt-bindir=/c/Qt/5.3.2/bin \
--with-protoc-bindir=/c/deps/protobuf-2.5.0/src
make
strip src/straks-cli.exe
strip src/straksd.exe
strip src/qt/straks-qt.exe
Straks Core release notes can be found here:
STRAKS release notes can be found here:
- [v1.14.5](release-notes/release-notes-1.14.5.md) released November/15/2017.
This diff is collapsed.
Release Process
====================
* update translations (ping wumpus, Diapolo or tcatm on IRC)
* see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
* * *
###update (commit) version in sources
......@@ -44,7 +41,7 @@ Release Process
Fetch and build inputs: (first time, or when dependency versions change)
wget 'http://miniupnp.free.fr/files/download.php?file=miniupnpc-1.9.20140701.tar.gz' -O miniupnpc-1.9.20140701.tar.gz
wget 'https://www.openssl.io/source/openssl-1.0.1k.tar.gz'
wget 'https://www.openssl.org/source/openssl-1.0.2g.tar.gz'
wget 'http://download.oracle.com/berkeley-db/db-4.8.30.NC.tar.gz'
wget 'http://zlib.net/zlib-1.2.8.tar.gz'
wget 'ftp://ftp.simplesystems.io/pub/png/src/history/libpng16/libpng-1.6.8.tar.gz'
......@@ -87,23 +84,6 @@ Release Process
./bin/gbuild ../straks/contrib/gitian-descriptors/gitian-osx-qt.yml
mv build/out/osx-*.tar.gz inputs/
The expected SHA256 hashes of the intermediate inputs are:
b1f6f10148d4c4a1a69a58e703427578dc5a4de86eefd6b925e3abf3c8fbe542 straks-deps-linux32-gitian-r9.zip
71e03e434af269dcbf3cb685cd1a5d51b8d2c904b67035eb4e5c1a2623b9f0df straks-deps-linux64-gitian-r9.zip
f29b7d9577417333fb56e023c2977f5726a7c297f320b175a4108cf7cd4c2d29 boost-linux32-1.55.0-gitian-r1.zip
88232451c4104f7eb16e469ac6474fd1231bd485687253f7b2bdf46c0781d535 boost-linux64-1.55.0-gitian-r1.zip
57e57dbdadc818cd270e7e00500a5e1085b3bcbdef69a885f0fb7573a8d987e1 qt-linux32-4.6.4-gitian-r1.tar.gz
60eb4b9c5779580b7d66529efa5b2836ba1a70edde2a0f3f696d647906a826be qt-linux64-4.6.4-gitian-r1.tar.gz
60dc2d3b61e9c7d5dbe2f90d5955772ad748a47918ff2d8b74e8db9b1b91c909 boost-win32-1.55.0-gitian-r6.zip
f65fcaf346bc7b73bc8db3a8614f4f6bee2f61fcbe495e9881133a7c2612a167 boost-win64-1.55.0-gitian-r6.zip
2af17b1968bd7d46b260c8d16474e1f339cde1b9e96265c80f6626ea0c2785a9 straks-deps-win32-gitian-r16.zip
7608bdf7848101d48ba8a296cb9c29ac68193405f11d8075fb46154ff3476233 straks-deps-win64-gitian-r16.zip
963e3e5e85879010a91143c90a711a5d1d5aba992e38672cdf7b54e42c56b2f1 qt-win32-5.2.0-gitian-r3.zip
751c579830d173ef3e6f194e83d18b92ebef6df03289db13ab77a52b6bc86ef0 qt-win64-5.2.0-gitian-r3.zip
e2e403e1a08869c7eed4d4293bce13d51ec6a63592918b90ae215a0eceb44cb4 protobuf-win32-2.5.0-gitian-r4.zip
a0999037e8b0ef9ade13efd88fee261ba401f5ca910068b7e0cd3262ba667db0 protobuf-win64-2.5.0-gitian-r4.zip
Build straksd and straks-qt on Linux32, Linux64, and Win32:
./bin/gbuild --commit straks=v${VERSION} ../straks/contrib/gitian-descriptors/gitian-linux.yml
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment