manage README

This commit is contained in:
keita
2021-03-03 18:09:42 +09:00
parent 948613c794
commit c88923291e
+10 -24
View File
@@ -6,6 +6,13 @@
# CocoaTweet # CocoaTweet
This is a library for using Twitter API from C++ This is a library for using Twitter API from C++
# Features
you can use these endpoint
- statuses/update
- statuses/destroy/:id
- favorites/create
- favorites/destroy
# Dependency # Dependency
- libcurl(openssl version) - libcurl(openssl version)
- libssl - libssl
@@ -15,7 +22,7 @@ This is a library for using Twitter API from C++
``` ```
# apt install clang cmake git libboost-dev libboost-test-dev libcurl4-openssl-dev libssl-dev nunja-build # apt install clang cmake git libboost-dev libboost-test-dev libcurl4-openssl-dev libssl-dev nunja-build
$ git clone https://github.com/koron0902/CocoaTweet $ git clone https://github.com/koron0902/CocoaTweet
$ cd CocoaTweet // HINT : see bellow for more build faster $ cd CocoaTweet
$ mkdir build $ mkdir build
$ cd build $ cd build
$ cmake .. -G Ninja $ cmake .. -G Ninja
@@ -29,10 +36,10 @@ $ ninja
- Get libcurl-32bit and OpenSSL-32bit from [here](https://curl.se/windows/) - Get libcurl-32bit and OpenSSL-32bit from [here](https://curl.se/windows/)
- Get ninja from [here](https://github.com/ninja-build/ninja/releases) and add PATH(Optional, but build faster) - Get ninja from [here](https://github.com/ninja-build/ninja/releases) and add PATH(Optional, but build faster)
and .... and then....
``` ```
$ git clone https://github.com/koron0902/CocoaTweet $ git clone https://github.com/koron0902/CocoaTweet
$ cd CocoaTweet // HINT : see bellow for more build faster $ cd CocoaTweet
$ mkdir build $ mkdir build
$ cd build $ cd build
@@ -45,27 +52,6 @@ $ cmake .. -G "MinGW Makefiles" -DOPENSSL_ROOT_DIR=<path/to/openssl/install> -DC
$ mingw32-make $ mingw32-make
``` ```
## -- HINT --
in the default, test code also linked when build.
you can build more faster modifing CMakeLists.txt
```
$ vi CMakeLists.txt (or other editor you like)
// line 73
# enable_testing()
// line 76
# add_subdirectory(test)
```
# Features
you can use these endpoint
- statuses/update
- statuses/destroy/:id
- favorites/create
- favorites/destroy
# How # How
## API Key Registration ## API Key Registration
### 1.Write Key into code ### 1.Write Key into code