Skip to content

Latest commit

 

History

History
89 lines (70 loc) · 4 KB

readme.md

File metadata and controls

89 lines (70 loc) · 4 KB
Raw

Codacy Badge

		 _    _ ______ _____  __  __ ______  _____ 
		| |  | |  ____|  __ \|  \/  |  ____|/ ____|
		| |__| | |__  | |__) | \  / | |__  | (___  
		|  __  |  __| |  _  /| |\/| |  __|  \___ \ 
		| |  | | |____| | \ \| |  | | |____ ____) |
		|_|  |_|______|_|  \_\_|  |_|______|_____/

DESCRIPTION:

Simple library helping with network requests, tasks management, logger and file based data storage, build with cross-platform environment in mind.

VERSION:

1.3.2

SUPPORTED PLATFORMS:

iOS, Android (NDK), macOS, Linux

LICENSE:

zlib

CONTRIBUTORS:

Patryk Nadrowski nadro-linux@wp.pl
Sebastian Markowski kansaidragon@gmail.com

DEPENDENCIES:

libcurl library - https://curl.haxx.se/libcurl
JsonCpp library - https://github.com/open-source-parsers/jsoncpp
LibreSSL library - https://www.libressl.org
aes library - https://github.com/BrianGladman/aes
zlib library - https://zlib.net
base64 code - https://github.com/ReneNyffenegger/cpp-base64
sha1 code - https://github.com/etodd/sha1

QUICK START

Android:

  • Add ANDROID_HOME environment variable with destination path set to Android SDK directory.
  • If you want to use SSL with curl, execute python3 ./build.py -target android command in $(HERMES_HOME)/depend/libressl before building curl.
  • Execute python3 ./build.py -target android command in
    • $(HERMES_HOME)/depend/jsoncpp
    • $(HERMES_HOME)/depend/aes
    • $(HERMES_HOME)/depend/zlib
    • $(HERMES_HOME)/depend/curl
  • Execute python3 ./build.py -target android from $(HERMES_HOME) directory.
  • From Android Studio import, build and run $(HERMES_HOME)/example/01.HelloWorld_Android project.

Debug

  • Add -debug parameter to build.py to build libraries in the debug mode -> python3 ./build.py -target android -debug.

Linux:

  • If you want to use SSL with curl, execute python3 ./build.py -target linux command in $(HERMES_HOME)/depend/libressl before building curl.
  • Execute python3 ./build.py -target linux command in
    • $(HERMES_HOME)/depend/jsoncpp
    • $(HERMES_HOME)/depend/aes
    • $(HERMES_HOME)/depend/zlib
    • $(HERMES_HOME)/depend/curl
  • Execute python3 ./build.py -target linux from $(HERMES_HOME) directory.
  • Execute make in $(HERMES_HOME)/example/01.HelloWorld directory and run 01.HelloWorld application.

Debug

  • Add -debug parameter to build.py to build libraries in the debug mode -> python3 ./build.py -target linux -debug.

iOS / macOS:

  • Execute python3 ./build.py -target apple command in
    • $(HERMES_HOME)/depend/jsoncpp
    • $(HERMES_HOME)/depend/aes
    • $(HERMES_HOME)/depend/zlib
    • $(HERMES_HOME)/depend/curl
  • Execute python3 ./build.py -target apple from $(HERMES_HOME) directory.
  • (iOS) From Xcode open, build and run $(HERMES_HOME)/example/01.HelloWorld_iOS project.
  • (macOS) Execute make in $(HERMES_HOME)/example/01.HelloWorld directory and run 01.HelloWorld application.

Debug / Variants

  • Add -debug parameter to build.py to build libraries in the debug mode -> python3 ./build.py -target apple -debug.
  • (iOS) Add -variant ios parameter to build.py to build libraries only for iOS -> python3 ./build.py -target apple -variant ios.
  • (macOS) Add -variant macos parameter to build.py to build libraries only for macOS -> python3 ./build.py -target apple -variant macos.

MISCELLANEOUS: