Skip to content

Commit 472f628

Browse files
authored
Create README.md
0 parents  commit 472f628

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# MakefileBuild Visual Studio Extension
2+
3+
## Overview
4+
5+
The `MakefileBuild` Visual Studio Extension adds functionality to Visual Studio to open and build Makefiles. The extension provides a command that can be triggered to build the active Makefile in the editor, using `make.exe` found in the system PATH.
6+
7+
## Features
8+
9+
- **Open Makefiles**: Recognize Makefiles in the Visual Studio environment.
10+
- **Build Makefiles**: Execute the `make` command to build the Makefile.
11+
- **Output Window Integration**: Displays build output and errors in the Visual Studio Output window.
12+
13+
## Installation
14+
15+
To install the extension:
16+
1. Clone this repository.
17+
2. Open the solution in Visual Studio.
18+
3. Build the solution to produce the `.vsix` file.
19+
4. Run the `.vsix` file to install the extension into Visual Studio.
20+
21+
## Usage
22+
23+
1. Open a Makefile in Visual Studio.
24+
2. Ensure `make.exe` is available in your system PATH.
25+
3. Trigger the `MakeCommand` from the command palette.
26+
27+
## Code Explanation
28+
29+
The core functionality is implemented in the `MakeCommand` class:
30+
31+
- **Initialization**: The `InitializeAsync` method sets up the command and output window.
32+
- **Execute Command**: The `Execute` method retrieves the active Makefile, identifies `make.exe` in the system PATH, and runs the `make` command.
33+
- **Output Handling**: Standard output and error from the `make` command are captured and displayed in the Visual Studio Output window.
34+
35+

0 commit comments

Comments
 (0)