Skip to content

Commit 82f7163

Browse files
authored
Update README.md
1 parent d9ccd8f commit 82f7163

File tree

1 file changed

+53
-3
lines changed

1 file changed

+53
-3
lines changed

README.md

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,54 @@
11
# vscode-cmake-cpp-linux-exe
2-
- .vscode setting for gcc(g++) and Linux
3-
- Setting for linux executable program
4-
2+
3+
This project provides a template and environment setup for developing C++ executable programs on Linux using CMake and Visual Studio Code. It is ideal for those who want a quick start with C++ development in a Linux environment, featuring ready-to-use configurations and minimal boilerplate.
4+
5+
## Features
6+
7+
- Pre-configured `.vscode` settings for seamless development in Visual Studio Code
8+
- Example `hello.cpp` source file to demonstrate a simple C++ executable
9+
- `CMakeLists.txt` for CMake-based build automation
10+
- Linux executable output setup
11+
- Organized structure for easy extension and scaling
12+
13+
## Getting Started
14+
15+
### Prerequisites
16+
17+
- [CMake](https://cmake.org/) (version 3.10 or higher recommended)
18+
- [g++](https://gcc.gnu.org/) or any compatible C++ compiler
19+
- [Visual Studio Code](https://code.visualstudio.com/)
20+
- [CMake Tools Extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools)
21+
22+
### Setup
23+
24+
1. Clone this repository:
25+
```bash
26+
git clone https://github.com/JayTwoLab/vscode-cmake-cpp-linux-exe.git
27+
cd vscode-cmake-cpp-linux-exe
28+
```
29+
30+
2. Open the folder in Visual Studio Code.
31+
32+
3. Make sure all required extensions and tools are installed (see Prerequisites).
33+
34+
4. Use the VSCode command palette (Ctrl+Shift+P) to run: `CMake: Configure` and then `CMake: Build`.
35+
36+
5. Run the executable as built in your configured output directory.
37+
38+
## Project Structure
39+
40+
- `.vscode/` - VSCode-specific settings for C++ and CMake integration
41+
- `CMakeLists.txt` - CMake build definition
42+
- `hello.cpp` - Example source file
43+
44+
## Usage
45+
46+
This repository serves as a starting point for your own C++ executable projects. Feel free to modify `hello.cpp` and extend as needed for your application.
47+
48+
## License
49+
50+
No license is set. Please add a LICENSE file if you plan to distribute or share this project.
51+
52+
## Author
53+
54+
- Maintained by [JayTwoLab](https://github.com/JayTwoLab)

0 commit comments

Comments
 (0)