From 8f1cabfc35511e335b147ca1bd3b7df49607a7dc Mon Sep 17 00:00:00 2001 From: Olemis Lang Date: Sun, 19 May 2019 15:10:45 -0400 Subject: [PATCH 1/4] [ci] refs #18 - Repository constraint set to skycoin/libskycoin for Travis deploy --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 724fef9fc..fd6c96199 100644 --- a/.travis.yml +++ b/.travis.yml @@ -51,7 +51,7 @@ deploy: draft: true overwrite: true on: - repo: skycoin/hardware-wallet + repo: skycoin/libskycoin tags: true notifications: email: false From 14304bd77447fb493fa0edd29a50d606a87d62ab Mon Sep 17 00:00:00 2001 From: Olemis Lang Date: Wed, 22 May 2019 23:57:15 -0400 Subject: [PATCH 2/4] Banner image . Put OS specific out of README --- README.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/README.md b/README.md index e3f5c4bb4..7670987ab 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[](https://user-images.githubusercontent.com/26845312/32426705-d95cb988-c281-11e7-9463-a3fce8076a72.png) +![](https://repository-images.githubusercontent.com/165332391/de95dc00-7cec-11e9-8fcb-d42fbd8e3577) # Skycoin C library @@ -156,15 +156,8 @@ After that, run `make docs` for a new docs generation. You can found the api doc |docs-skyapi |Generate SkyApi (libcurl) documentation| |lint |Run linters. Use make install-linters first.| |check |Run tests and linters| -|install-linters-Linux |Install linters on GNU/Linux| -|install-linters-Darwin |Install linters on Mac OSX| -|install-deps-Linux |Install deps on GNU/Linux| -|install-deps-Darwin |Install deps on Mac OSX| |install-libraries-deps |Install deps for `lib\curl` wrapper of Skycoin REST API| |install-linters |Install linters| -|install-deps-libc-linux |Install locally dependencies for testing libskycoin| -|install-lib-curl |Install Sky Api curl based rest wrapper| -|install-deps-libc-osx |Install locally dependencies for testing libskycoin| |format |Formats the code. Must have goimports installed (use make install-linters).| |clean-libc |Clean files generate by library| From 31ce3fd82fbeea1e7a922198f5c1ea295f192953 Mon Sep 17 00:00:00 2001 From: Olemis Lang Date: Thu, 23 May 2019 00:01:49 -0400 Subject: [PATCH 3/4] Merge Make rules and Make targets sections --- README.md | 45 ++++++++++++++++----------------------------- 1 file changed, 16 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 7670987ab..b980706f0 100644 --- a/README.md +++ b/README.md @@ -42,15 +42,22 @@ Consult respective `README` files for further details. All these make rules require skycoin to be a git submodule of pyskycoin -- `build-libc` - * Compiles skycoin C language library. -- `test-libc` - * Compiles skycoin C language library and executes the tests. -- `build-libc-static` - * Build libskycoin C static library -- `build-libc-shared` - * Build libskycoin C shared library - +|Target |Help| +| :------------- | :----------: | +|build-libc-static |Build libskycoin C static library| +|build-libc-shared |Build libskycoin C shared library| +|build-libc |Build libskycoin C client libraries| +|build |Build all C libraries +|test-libc |Run tests for libskycoin C client library| +|docs |Generate documentation for all libraries| +|docs-libc |Generate libskycoin documentation| +|docs-skyapi |Generate SkyApi (libcurl) documentation| +|lint |Run linters. Use make install-linters first.| +|check |Run tests and linters| +|install-libraries-deps |Install deps for `lib\curl` wrapper of Skycoin REST API| +|install-linters |Install linters| +|format |Formats the code. Must have goimports installed (use make install-linters).| +|clean-libc |Clean files generate by library| ## Development setup @@ -141,23 +148,3 @@ This code example can be found at `include/cipher.bitcoin.go.h`. Inside `/* */` we found struct documentation, meanwhile `//<` symbol is used to describe fields of the struct. After that, run `make docs` for a new docs generation. You can found the api documentation at `docs/libc` folder. - -### Makefile targets: - -|Target |Help| -| :------------- | :----------: | -|build-libc-static |Build libskycoin C static library| -|build-libc-shared |Build libskycoin C shared library| -|build-libc |Build libskycoin C client libraries| -|build |Build all C libraries -|test-libc |Run tests for libskycoin C client library| -|docs |Generate documentation for all libraries| -|docs-libc |Generate libskycoin documentation| -|docs-skyapi |Generate SkyApi (libcurl) documentation| -|lint |Run linters. Use make install-linters first.| -|check |Run tests and linters| -|install-libraries-deps |Install deps for `lib\curl` wrapper of Skycoin REST API| -|install-linters |Install linters| -|format |Formats the code. Must have goimports installed (use make install-linters).| -|clean-libc |Clean files generate by library| - From 61c743a2eab51986c3f36c769410fa2a39f72107 Mon Sep 17 00:00:00 2001 From: Olemis Lang Date: Thu, 23 May 2019 00:03:41 -0400 Subject: [PATCH 4/4] pyskycoin => libskycoin in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b980706f0..3fb51c4f1 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Consult respective `README` files for further details. ## Make Rules -All these make rules require skycoin to be a git submodule of pyskycoin +All these make rules require skycoin to be a git submodule of libskycoin |Target |Help| | :------------- | :----------: | @@ -109,7 +109,7 @@ in sync with the corresponding tag of `skycoin/skycoin` official repository. Stable development branches are created most of the time for the following reasons: - A Skycoin release increasing [patch version number](https://semver.org/). -- Enhanced support and bug fixes for a version of PySkycoin compiled against an +- Enhanced support and bug fixes for a version of the library compiled against an stable version of Skycoin - Backporting useful features added in `develop`.