Skip to content

Commit

Permalink
chore: v0.18.0 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
aminya committed Jul 11, 2022
1 parent 927edb5 commit 6f82d12
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Install all the tools required for building and testing C++/C projects.

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 **modular** and as **minimal** as possible. This will allow you to install the tools you want. It is continuously tested and supported on several configurations including Windows (11, 10, 2022, 2019), Linux (Ubuntu 22.04, Ubuntu 20.04, ArchLinux), and macOS (10.15 and 11).
`setup-cpp` can be used locally from terminal, from CI services like GitHub Actions and GitLab Pipelines, and inside containers like Docker.

The package can be used locally or from CI services like GitHub Actions.
`setup-cpp` is supported on many platforms. It is continuously tested on several configurations including Windows (11, 10, 2022, 2019), Linux (Ubuntu 22.04, Ubuntu 20.04, Fedora, ArchLinux), and macOS (10.15 and 11). `setup-cpp` is backed by unit tests for each tool and integration tests for compiling cpp projects.

# Features

`setup-cpp` can install all of these tools:
`setup-cpp` is **modular** and you can choose to install any of these tools:

| category | tools |
| --------------------- | ------------------------------------------------------------ |
Expand All @@ -36,21 +36,21 @@ Tip: You can automate downloading using `wget`, `curl`, or other similar tools.

### Executable

Download the executable for your platform from [here](https://github.com/aminya/setup-cpp/releases/tag/v0.17.0), and run it with the available options.
Download the executable for your platform from [here](https://github.com/aminya/setup-cpp/releases/tag/v0.18.0), and run it with the available options.

An example that installs llvm, cmake, ninja, ccache, and vcpkg:

```ps1
# windows example (open shell as admin)
curl.exe -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp_windows.exe"
curl.exe -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp_windows.exe"
.\setup_cpp_windows --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
RefreshEnv.cmd # activate cpp environment variables
```

```ps1
# linux example
wget "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp_linux"
wget "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp_linux"
chmod +x setup_cpp_linux
sudo ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Expand All @@ -59,7 +59,7 @@ source ~/.cpprc # activate cpp environment variables

```ps1
# mac example
wget "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp_mac"
wget "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp_mac"
chmod +x setup_cpp_mac
sudo ./setup_cpp_mac --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
Expand All @@ -74,15 +74,15 @@ NOTE: On Unix systems, you will not need `sudo` if you are already a root user (

### With Nodejs

Download the `setup_cpp.js` file form [here](https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp.js), and run it with the available options.
Download the `setup_cpp.js` file form [here](https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp.js), and run it with the available options.

On Windows:

Open the shell as admin, download via `curl`, then install

```ps1
# open shell as admin
curl.exe -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp.js"
curl.exe -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp.js"
node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
RefreshEnv.cmd # activate cpp environment variables
Expand All @@ -91,7 +91,7 @@ RefreshEnv.cmd # activate cpp environment variables
On Linux or Mac:

```ps1
wget "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp.js"
wget "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp.js"
sudo node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
source ~/.cpprc # activate cpp environment variables
Expand Down Expand Up @@ -170,7 +170,7 @@ FROM ubuntu:22.04 AS base
WORKDIR "/"
RUN apt-get update -qq
RUN apt-get install -y --no-install-recommends wget
RUN wget --no-verbose "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp_linux"
RUN wget --no-verbose "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp_linux"
RUN chmod +x ./setup_cpp_linux

# install llvm, cmake, ninja, and ccache
Expand Down Expand Up @@ -264,7 +264,7 @@ stages:
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 1E9377A2BA9EF27F

.setup_cpp: &setup_cpp |
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp_linux"
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp_linux"
chmod +x setup_cpp_linux
./setup_cpp_linux --compiler $compiler --cmake true --ninja true --ccache true --vcpkg true
source ~/.cpprc
Expand Down
2 changes: 1 addition & 1 deletion dev/docker/ubuntu.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ FROM ubuntu:22.04 AS base
WORKDIR "/"
RUN apt-get update -qq
RUN apt-get install -y --no-install-recommends wget
RUN wget --no-verbose "https://github.com/aminya/setup-cpp/releases/download/v0.17.0/setup_cpp_linux"
RUN wget --no-verbose "https://github.com/aminya/setup-cpp/releases/download/v0.18.0/setup_cpp_linux"
RUN chmod +x ./setup_cpp_linux

# install llvm, cmake, ninja, and ccache
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "setup-cpp",
"version": "0.17.0",
"version": "0.18.0",
"description": "Install all the tools required for building and testing C++/C projects.",
"repository": "https://github.com/aminya/setup-cpp",
"license": "Apache-2.0",
Expand Down

0 comments on commit 6f82d12

Please sign in to comment.