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

Commit 2bf80de

Browse files
committedMay 13, 2023
Update README.md
1 parent 88ed38a commit 2bf80de

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed
 

‎README.md

+25-17
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,48 @@ contests that require submitting a solution as a single source file.
77

88
#### Prerequisites
99

10-
* node
10+
* Node.js
1111
* npm
12-
* yarn (optional)
12+
* Yarn (optional)
1313

1414
#### Installation from npm
1515

16-
```
16+
```shell
1717
npm install -g cpp-merge
1818
```
1919

2020
#### Installation from source
2121

2222
##### Clone git repository
2323

24-
```
25-
git clone git@github.com:RandomVoid/cpp-merge.git
24+
```shell
25+
git clone git@github.com:FastAlien/cpp-merge.git
2626
```
2727

28-
##### Build and link package
28+
##### Build
29+
30+
Go to the project directory and run the following commands.
2931

3032
Using npm:
3133

32-
```
33-
npm install
34+
```shell
35+
npm ci
3436
npm run build
35-
npm link
3637
```
3738

38-
Or using yarn:
39+
Using Yarn:
3940

40-
```
41-
yarn
41+
```shell
42+
yarn install
4243
yarn build
43-
yarn link
44+
```
45+
46+
##### Link package
47+
48+
Go to the project directory and run the following command:
49+
50+
```shell
51+
npm -g link
4452
```
4553

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

6977
Display the build-in help:
7078

71-
```
79+
```shell
7280
cpp-merge --help
7381
```
7482

7583
#### Usage examples
7684

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

79-
```
87+
```shell
8088
cpp-merge main.cpp
8189
```
8290

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

85-
```
93+
```shell
8694
cpp-merge --output output.cpp main.cpp
8795
```
8896

8997
Specify additional include and source directory:
9098

91-
```
99+
```shell
92100
cpp-merge --include ../include --source ../src main.cpp
93101
```

0 commit comments

Comments
 (0)
This repository has been archived.