Skip to content

Commit 4285e7b

Browse files
committed
chore: fix readme
1 parent fa26938 commit 4285e7b

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,32 @@ Install all the tools required for building and testing C++/C projects.
55
![Build Status (Github Actions)](https://github.com/aminya/setup-cpp/workflows/CI/badge.svg)
66
[![Dependency Status](https://david-dm.org/aminya/setup-cpp.svg)](https://david-dm.org/aminya/setup-cpp)
77

8-
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.
8+
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.
99

10-
This package is designed to be fully **modular** and as **minimal** as possible. This will allow you to only install the tools you want.
10+
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.
1111

12-
The package will be usable from any environment (locally, GitHub Actions, etc). Stay tuned for the stable release.
12+
The package can be used locally or from CI services like GitHub Actions. Stay tuned for the stable release.
1313

14-
# Features (WIP)
14+
# Features
1515

16-
- setup llvm
17-
- setup gcc/mingw
18-
- setup cmake
19-
- setup ninja
20-
- setup meson
21-
- setup conan
22-
- setup ccache
23-
- setup cppcheck
24-
- setup doxygen
25-
- setup gcovr
26-
- setup OpenCppCoverage
27-
- setup python
28-
- setup choco
29-
- setup brew
16+
`setup-cpp` can install all of these tools:
3017

31-
### Incomplete
32-
33-
- [ ] setup msvc. See [this issue](https://github.com/aminya/setup-cpp/issues/1)
18+
- llvm
19+
- gcc and mingw
20+
- cmake
21+
- ninja
22+
- meson
23+
- conan
24+
- ccache
25+
- cppcheck
26+
- doxygen
27+
- gcovr
28+
- opencppcoverage
29+
- python
30+
- choco
31+
- brew
3432

35-
### TODO
33+
### Incomplete
3634

37-
- [ ] setup vcpkg
35+
- [ ] msvc. It is implemented, but has bugs. See [this issue](https://github.com/aminya/cpp/issues/1)
36+
- [ ] vcpkg (TODO)

0 commit comments

Comments
 (0)