chore: add readme about running the tool locally

This commit is contained in:
Amin Yahyaabadi 2021-09-17 13:24:17 -05:00
parent 8a23537c88
commit b263e7930c
1 changed files with 20 additions and 0 deletions

View File

@ -32,6 +32,26 @@ The package can be used locally or from CI services like GitHub Actions. Stay tu
# Usage
## From Command Prompt
You should download the exe file or the js file (if have Nodejs installed) and then run it.
Tip: You can automate downloading using `wget`, `curl` or other similar tools.
### Executable
```
./setup_cpp.exe --compiler llvm --cmake true --ninja true --ccache true --conan "1.40.1"
```
### With Nodejs
Download the `setup_cpp.js` file form [here](https://github.com/aminya/setup-cpp/blob/master/dist/main.js), and run it
```
node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --conan "1.40.1"
```
## Inside GitHub Actions
Here is a complete cross-platform example that tests llvm and gcc. It also uses cmake, ninja, conan, cppcheck, and ccache.