actions
/
setup-cpp
Template
mirror of https://github.com/aminya/setup-cpp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add readme

This commit is contained in:
Amin Yahyaabadi 2021-09-14 04:40:04 -05:00
parent b957bc4ab8
commit 1239cfc4a6
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -2,7 +2,26 @@
Install all the tools required for building and testing C++/C projects.
The last setup-cpp action that you need.
![Build Status (Github Actions)](https://github.com/aminya/setup-cpp/workflows/CI/badge.svg)
[![Dependency Status](https://david-dm.org/aminya/setup-cpp.svg)](https://david-dm.org/aminya/setup-cpp)
Settting up a **cross-platform** enviroment for building and testing C++/C projects is a bit tricky. Each platform has its own comopilers, and each of them require a different installation procedure. This package aims to fix this issue.
This package is designed to be fully **modular** and as **minimal** as possible. This will allow you to only install the tools you want.
The package will be usable locally or inside GitHub Actions. Stay tuned for the stable release.
# Features (WIP)
- [x] setup cmake
- [x] setup ninja
- [ ] setup llvm
- [ ] setup gcc/mingw
- [ ] setup msvc
- [ ] setup conan
- [ ] setup meson
- [ ] setup vcpkg
- [ ] setup gcovr
- [ ] setup OpenCppCoverage
- [ ] setup cppcheck
- [ ] setup doxygen