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

chore: fix readme

This commit is contained in:
Amin Yahyaabadi 2021-09-17 06:29:58 -05:00
parent fa26938fb4
commit 4285e7bb04
1 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -5,33 +5,32 @@ Install all the tools required for building and testing C++/C projects.
![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.
Setting up a **cross-platform** environment for building and testing C++/C projects is a bit tricky. Each platform has its own compilers, and each of them requires 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.
This package is designed to be **modular** and as **minimal** as possible. This will allow you to install the tools you want. It is continuously tested on Windows, Linux, and macOS.
The package will be usable from any environment (locally, GitHub Actions, etc). Stay tuned for the stable release.
The package can be used locally or from CI services like GitHub Actions. Stay tuned for the stable release.
# Features (WIP)
# Features
- setup llvm
- setup gcc/mingw
- setup cmake
- setup ninja
- setup meson
- setup conan
- setup ccache
- setup cppcheck
- setup doxygen
- setup gcovr
- setup OpenCppCoverage
- setup python
- setup choco
- setup brew
`setup-cpp` can install all of these tools:
- llvm
- gcc and mingw
- cmake
- ninja
- meson
- conan
- ccache
- cppcheck
- doxygen
- gcovr
- opencppcoverage
- python
- choco
- brew
### Incomplete
- [ ] setup msvc. See [this issue](https://github.com/aminya/setup-cpp/issues/1)
### TODO
- [ ] setup vcpkg
- [ ] msvc. It is implemented, but has bugs. See [this issue](https://github.com/aminya/cpp/issues/1)
- [ ] vcpkg (TODO)