github.com/c3pm-labs/c3pm@v0.3.0/README.md (about)

     1  <p align="center">
     2    <a href="https://c3pm.io/">
     3      <img alt="c3pm" src="https://c3pm.io/assets/c3pm.png" width="546"/>
     4    </a>
     5  </p>
     6  
     7  <p align="center">
     8      Your toolkit to dive into C++ easily
     9  </p>
    10  
    11  ---
    12  
    13  <!-- START doctoc generated TOC please keep comment here to allow auto update -->
    14  <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
    15  **Table of Contents**
    16  
    17  - [What is c3pm?](#what-is-c3pm)
    18  - [Installing c3pm](#installing-c3pm)
    19  - [Usage](#usage)
    20    - [Start your project](#start-your-project)
    21    - [Add a package](#add-a-package)
    22    - [Building your project](#building-your-project)
    23    - [Publishing your project](#publishing-your-project)
    24  - [Releases](#releases)
    25  - [Contributing](#contributing)
    26  - [Support](#support)
    27    - [Ask a question](#ask-a-question)
    28    - [Create a bug report](#create-a-bug-report)
    29    - [Submit a feature request](#submit-a-feature-request)
    30  
    31  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
    32  
    33  ## What is c3pm?
    34  
    35  **c3pm** stands for C++ package manager.
    36  
    37  c3pm abstracts your build system and eases the management of your dependencies.
    38  
    39  It manages your CMake and compiles your project with **minimal configuration**.
    40  
    41  Feel free to explore the available packages on our [platform](https://c3pm.io).
    42  
    43  ## Installing c3pm
    44  
    45  You can check [our documentation](https://docs.c3pm.io/docs/getting_started/install) to see how to install c3pm
    46  
    47  ## Usage
    48  
    49  Once you installed c3pm, you can start using it.
    50  Here are some basic commands you will need.
    51  
    52  ### Start your project
    53  ```shell
    54  $ ctpm init
    55  ```
    56  
    57  ### Add a package
    58  ```shell
    59  $ ctpm add <package>
    60  ```
    61  
    62  
    63  ### Building your project
    64  ```shell
    65  $ ctpm build
    66  ```
    67  
    68  ### Publishing your project
    69  
    70  ```shell
    71  $ ctpm publish
    72  ```
    73  
    74  <br />
    75  
    76  You can find a more complete list of the available commands [here](https://github.com/gabrielcolson/c3pm/tree/master/specs/cli) !
    77  
    78  ## Contributing
    79  
    80  Contributions are welcomed!
    81  
    82  Refer to our [contribution guidelines](https://github.com/gabrielcolson/c3pm/blob/master/CONTRIBUTING.md).
    83  
    84  You also may need the documentation of the different stacks:
    85  [api](https://github.com/gabrielcolson/c3pm/blob/master/api/README.md) -
    86  [web](https://github.com/gabrielcolson/c3pm/blob/master/web/README.md) -
    87  [cli](https://github.com/gabrielcolson/c3pm/blob/master/cli/README.md)
    88  
    89  ## Support
    90  
    91  ### Ask a question
    92  
    93  You can email us at: contact@c3pm.io or join our [discord](https://discord.gg/CU8Qbex3wP)