Skip to content

Home

Jump to bottom
outsider1305 edited this page Jul 17, 2022 · 19 revisions

Requirements and Recommendations

Note: Cppm has only been tested with Clang/Clang++ and GCC/G++; either one is compatible with Cppm, though so far it's only these that are supported.

  • clang-tidy, clangd, and clang-format will be needed if you wish to use cppm's integrated linting and formatting
  • Git and Visual Studio Code are recommended for usage with Cppm

If you're on Linux, some of these tools may already be installed. All requirements must be on your PATH (See Below).

Downloads and Installation

There are three ways to get Cppm:

  1. Download the latest build for Windows and Ubuntu.
  2. Install with Cargo: cargo install cppm
  3. Get with our custom installer. (Not recommended, is being rewritten at the moment.)

If you installed cppm from GH, you must place it in a directory that is on your PATH (See below)

How to add directories to the path on Windows. How to add directories to the path on Unix.

Quick Start Guide

Cppm needs to be configured on a fresh install. In the future, unless you install new tools, this step can be glossed over.

Run cppm --config and Cppm will configure itself, at least for the most part. You can begin using Cppm after the initial configuration command is ran, but if you'd like to utilize the full functionality, you need to enable it yourself; see the Usage page to finish configuring Cppm.

Example of cppm --config being used in a terminal

> cppm --config
Default editor: nvim
Clang is installed.
Clang++ is installed.
Location: /some/path/.cppm/defaults.toml

Take me to the next page!

Clone this wiki locally