Initial Commit

README.md

@@ -0,0 +1,115 @@
+![](https://github.com/eosswedenorg/libeosio/workflows/CI/badge.svg)
+[![GitHub release](https://img.shields.io/github/v/release/eosswedenorg/libeosio?include_prereleases)](https://github.com/eosswedenorg/libeosio/releases/latest)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# libeosio
+
+Independent C++ library for [EOS](https://eos.io/)
+
+NOTE: This repository has no connection to the official EOS code.
+
+## Compiling the library
+
+You will need `openssl` development files (version 1.1 or later) to compile and `cmake 3.15` or later to compile this project.
+
+### CMake
+
+You can install `cmake` by reading the [official guide](https://cmake.org/install).
+
+### Linux
+
+#### Dependencies
+
+**Ubuntu (or other debian based distros)**
+
+First you need to have a compiler, `openssl` and `cmake`. this can be installed with apt.
+
+```sh
+$ apt-get install gcc g++ cmake libssl-dev
+```
+If you need a newer version of cmake then apt provides.
+Checkout the official [CMake APT repository](https://apt.kitware.com/).
+
+**Other**
+
+Consult your package manager's manual for getting `openssl`,`g++` and `cmake` installed.
+
+If you need a newer version of cmake then your package manager provides. checkout the [official guide](https://cmake.org/install).
+
+### MacOS
+
+#### Dependencies
+
+You must have a compiler installed. This project is known to build with `Xcode 11.0` but other versions should work.
+
+You need to have openssl and cmake installed also, this can be done with this `brew` command:
+```sh
+$ brew install openssl cmake
+```
+
+If you need a newer version of cmake then brew provides. checkout the [official guide](https://cmake.org/install)
+
+#### Build
+
+```sh
+$ mkdir build && cd build
+$ cmake .. && make
+```
+
+**MacOS:** You may need to point `cmake` to `openssl` by passing the argument
+`-D OPENSSL_ROOT_DIR=/usr/local/opt/openssl@1.1` if openssl is not under `/usr/local/opt/openssl@1.1` you need to find the correct path.
+
+### Windows
+
+#### Dependencies
+
+First you will need a compiler.
+
+[Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) (Selecting C++ during installation) is recommended.
+
+By default `cmake` will use the bundled openssl package located at `vendor/openssl-1.1.1e-win-static.zip`
+
+If you like to use an other version of OpenSSL then the static one bundled with this repo
+you need to set `OPENSSL_ROOT_DIR` to the directory where OpenSSL is located on the system.
+
+For example:
+
+```
+C:\repo> cmake -D OPENSSL_ROOT_DIR=C:/path/to/openssl -B build
+```
+
+**NOTE:** `cmake` uses forward slash `/` for path even for windows. so make sure you use that when setting `OPENSSL_ROOT_DIR`
+
+#### Build.
+
+Run cmake
+
+```
+C:\repo> cmake -B build
+C:\repo> cmake --build build --config Release
+```
+
+## Security notice
+
+Keys are generated by `OpenSSL`'s `EC_KEY_generate_key` function. The program will
+never expose your keys to anything but the computers memory and output of the
+program. You are free to inspect the source code and compile yourself to verify.
+
+However, use this at your own risk. we cannot guarantee that the keys are
+cryptographically secure as this depends on OpenSSL's implementation (alto it is
+widely used and should be safe)
+
+Please read the `LICENSE` file.
+
+```
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+## Author
+
+Henrik Hautakoski - [henrik@eossweden.org](mailto:henrik@eossweden.org)