Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FastAlien committed May 13, 2023
1 parent 88ed38a commit 2bf80de
Showing 1 changed file with 25 additions and 17 deletions.
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,48 @@ contests that require submitting a solution as a single source file.

#### Prerequisites

* node
* Node.js
* npm
* yarn (optional)
* Yarn (optional)

#### Installation from npm

```
```shell
npm install -g cpp-merge
```

#### Installation from source

##### Clone git repository

```
git clone git@github.com:RandomVoid/cpp-merge.git
```shell
git clone git@github.com:FastAlien/cpp-merge.git
```

##### Build and link package
##### Build

Go to the project directory and run the following commands.

Using npm:

```
npm install
```shell
npm ci
npm run build
npm link
```

Or using yarn:
Using Yarn:

```
yarn
```shell
yarn install
yarn build
yarn link
```

##### Link package

Go to the project directory and run the following command:

```shell
npm -g link
```

## Usage
Expand Down Expand Up @@ -68,26 +76,26 @@ alphabetically. Any of the processed header and source files will not be changed

Display the build-in help:

```
```shell
cpp-merge --help
```

#### Usage examples

Process `main.cpp` and display produced content on the standard output:

```
```shell
cpp-merge main.cpp
```

Process `main.cpp` and save output to file `output.cpp`:

```
```shell
cpp-merge --output output.cpp main.cpp
```

Specify additional include and source directory:

```
```shell
cpp-merge --include ../include --source ../src main.cpp
```

0 comments on commit 2bf80de

Please sign in to comment.