|
| 1 | +# Quick C++ - C Inline Execution for VS Code |
| 2 | + |
| 3 | +**Quick C++** is a VS Code extension that allows users to run C++ code snippets directly within the editor. It provides inline output for quick debugging and execution insights, making C++ development more efficient. |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <img src="https://raw.githubusercontent.com/Codegyan-LLC/QuickCPP/refs/heads/main/images/code.png" width="600" alt="Quick C++ Example"> |
| 7 | +</p> |
| 8 | + |
| 9 | +## Getting Started |
| 10 | + |
| 11 | +Installation |
| 12 | + |
| 13 | +1. **VS Code Marketplace :** |
| 14 | + * Open Visual Studio Code. |
| 15 | + * Navigate to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS). |
| 16 | + * Search for Quick C++. |
| 17 | + * Click "Install" to add the extension to your VS Code. |
| 18 | + |
| 19 | +2. **Install from VSIX :** |
| 20 | + - Download the latest `.vsix` package from the [Releases](#) page. |
| 21 | + - Open Visual Studio Code. |
| 22 | + - Go to the Extensions view by clicking on the Extensions icon in the Activity Bar or pressing `Ctrl+Shift+X`. |
| 23 | + - Click on the ellipsis (`...`) in the top-right corner of the Extensions view and select "Install from VSIX...". |
| 24 | + - Navigate to the downloaded `.vsix` file and select it to install. |
| 25 | + |
| 26 | +## Features |
| 27 | + |
| 28 | +* `Inline Code Execution`: Run C++ code directly in the editor and display results as inline comments. |
| 29 | +* `Real-Time Updates`: Automatically executes code on text changes or cursor movements. |
| 30 | +* `Error Feedback`: Catch errors like NameError and display clear, formatted messages inline. |
| 31 | +* `Temporary File Execution`: Ensures safe execution using temporary files without modifying your project files. |
| 32 | +* `Output Formatting`: Displays clean and non-intrusive inline output for easy readability. |
| 33 | +* `Enhanced Debugging`: Provides feedback for incomplete or invalid code to help developers debug faster. |
| 34 | + |
| 35 | +## Usage |
| 36 | + |
| 37 | +### Auto Execution |
| 38 | + |
| 39 | +Just write a C++ echo, print_r, or var_dump statement, and the output will appear inline. |
| 40 | + |
| 41 | +``` cpp |
| 42 | +#include <iostream> |
| 43 | +using namespace std; |
| 44 | + |
| 45 | +int main() { |
| 46 | + cout << "Hello, QuickCPP!" << endl; // Output: Hello, QuickCPP! |
| 47 | + return 0; |
| 48 | +} |
| 49 | +``` |
| 50 | + |
| 51 | +### Error Highlighting |
| 52 | + |
| 53 | +Errors are shown inline, with the file and line number. |
| 54 | +``` cpp |
| 55 | +#include <iostream> |
| 56 | +using namespace std; |
| 57 | + |
| 58 | +int main() { |
| 59 | + cout << "Hello, QuickCPP!" << endl // error: expected ';' before 'return' |
| 60 | + return 0; |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +## Known Issues |
| 65 | +* Large scripts or complex logic may cause delays in execution. |
| 66 | +* Inline execution is limited to the lines above the current cursor. |
| 67 | + |
| 68 | +Feel free to report bugs or suggest features by opening an issue on GitHub. |
| 69 | + |
| 70 | +## Contributing |
| 71 | + |
| 72 | +Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request on the Github. |
| 73 | + |
| 74 | +## License |
| 75 | + |
| 76 | +This extension is licensed under the **[MIT license](https://opensource.org/licenses/MIT)**. |
| 77 | + |
| 78 | + |
| 79 | +## Contact |
| 80 | + |
| 81 | +For questions or feedback, please contact support@codegyan.in. |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +Thank you for using **Quick C++**! We hope it enhances your coding experience. |
| 86 | + |
| 87 | + |
0 commit comments