Skip to content

Commit

Permalink
[docs] refs #51 Refactored some endpoints in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stdevMac committed May 24, 2019
1 parent ceb9f36 commit 8f7873f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ install-deps-skyapi-Darwin:
brew install openssl curl uncrustify || true
(cd deps && wget http://curl.haxx.se/download/curl-7.58.0.tar.gz && tar -xf curl-7.58.0.tar.gz && cd curl-7.58.0/ && mkdir build && cd build && cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl .. && make && sudo make install)

install-deps-libc: install-deps-libc-$(UNAME_S)
install-deps-libc: install-deps-libc-$(UNAME_S) ## Install deps for libc

install-deps-skyapi: install-deps-skyapi-$(UNAME_S) ## Install skyapi(libcurl based) library.

Expand All @@ -201,6 +201,8 @@ install-deps-libc-Linux: configure-build ## Install locally dependencies for tes
install-deps-libc-Darwin: configure-build ## Install locally dependencies for testing libskycoin
brew install check

install-deps: install-deps-libc install-deps-skyapi ## Install deps for libc and skyapi

format: ## Formats the code. Must have goimports installed (use make install-linters).
goimports -w -local github.com/skycoin/skycoin ./lib

Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ All these make rules require skycoin to be a git submodule of libskycoin
|docs-skyapi |Generate SkyApi (libcurl) documentation|
|lint |Run linters. Use make install-linters first.|
|check |Run tests and linters|
|install-deps |Install deps for libc and skyapi|
|install-deps-libc |Install deps for libc|
|install-deps-skyapi |Install skyapi(libcurl based) library.|
|install-linters |Install linters|
|format |Formats the code. Must have goimports installed (use make install-linters).|
Expand Down Expand Up @@ -153,3 +155,4 @@ 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.

0 comments on commit 8f7873f

Please sign in to comment.