From 1239cfc4a636f472d866869ea6fae6ebcdf38715 Mon Sep 17 00:00:00 2001 From: Amin Yahyaabadi Date: Tue, 14 Sep 2021 04:40:04 -0500 Subject: [PATCH] docs: add readme --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 054a929f..c7287768 100644 --- a/README.md +++ b/README.md @@ -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