Add GCC installation steps to README#27
Add GCC installation steps to README#27Tushar15769 wants to merge 3 commits intogpl-gowthamchand:masterfrom
Conversation
📝 WalkthroughWalkthroughThe PR expands README.md with detailed, OS-specific GCC installation and verification instructions, and updates the Running Your First Program steps to include explicit save/compile/run commands. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new multi-component control flow) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 68-72: Remove the trailing space from the "### macOS" heading and
make the section match the Windows section's numbered/intro format: add a brief
introductory sentence (e.g., "Install Xcode command line tools and verify the
installation."), wrap the commands in proper fenced code blocks, and present
them as numbered steps (step 1: xcode-select --install, step 2: gcc --version)
so the "### macOS" heading and the command list are consistently formatted with
the rest of the README.
- Around line 55-59: In the Windows section the verification command `gcc
--version` is not in a code block; update the Windows block (the "Windows"
heading and its bullet list) to wrap the verification command in a fenced code
block (use ```bash on the opening fence and ``` on the closing fence) so it
matches the Linux/macOS formatting and shows the command as code.
- Around line 50-52: The "## Installing GCC (GNU Compiler Collection)" heading
is incorrectly nested under the "### Prerequisites" subsection and breaks the
prerequisites list; either demote it to a level-3 heading to match the section
hierarchy or, preferably, move the GCC installation content out of the
prerequisites block and into the separate installation area (or replace it with
a single link to 00_installation.md). Update the README.md by relocating the GCC
steps so the prerequisites bulleted list remains contiguous, ensure the heading
levels are consistent with "### Prerequisites" (or change that heading if you
intend a higher-level section), and replace the inlined install steps with "See
[Installation Guide](00_installation.md)" if consolidating to the existing
installation file.
🧹 Nitpick comments (3)
README.md (3)
61-67: LGTM with a minor suggestion.The Linux installation instructions are accurate and properly formatted. The commands using
build-essentialpackage is the correct approach for Ubuntu/Debian systems.Optional improvement: For consistency, consider formatting the introduction similar to Windows:
-### Linux (Ubuntu / Debian) -Open a terminal and run: +### Linux (Ubuntu / Debian) +1. Open a terminal and run the following commands:
50-72: Consider consolidating with existing installation guide.This README already references a dedicated installation guide at line 12:
[00. Installation](00_installation.md). Adding detailed installation instructions here creates content duplication, which increases maintenance burden.Consider instead enhancing the
00_installation.mdfile with these instructions and keeping the README concise with a link:### Prerequisites -- GCC compiler (GNU Compiler Collection) - -## Installing GCC (GNU Compiler Collection) - -GCC is required to compile and run C programs. Follow the steps below -based on your operating system. - -### Windows -1. Download and install **MinGW-w64** or **TDM-GCC**. -2. During installation, make sure to select the option to add GCC to the system PATH. -3. After installation, open Command Prompt and verify: -gcc --version - -### Linux (Ubuntu / Debian) -Open a terminal and run: -```bash -sudo apt update -sudo apt install build-essential -gcc --version -``` -### macOS -```bash -xcode-select --install -gcc --version -``` +- GCC compiler (GNU Compiler Collection) - [Installation instructions](00_installation.md) - Basic understanding of programming concepts (helpful but not required)This approach:
- Keeps the README concise and scannable
- Avoids duplication and maintenance overhead
- Directs users to comprehensive installation documentation
- Follows the pattern established by other topics in the repository
52-53: Minor: Improve text formatting.The introductory text is split awkwardly across lines 52-53.
🔧 Suggested improvement
-GCC is required to compile and run C programs. Follow the steps below -based on your operating system. +GCC is required to compile and run C programs. Follow the steps below based on your operating system:
| ### Windows | ||
| 1. Download and install **MinGW-w64** or **TDM-GCC**. | ||
| 2. During installation, make sure to select the option to add GCC to the system PATH. | ||
| 3. After installation, open Command Prompt and verify: | ||
| gcc --version |
There was a problem hiding this comment.
Fix inconsistent code block formatting.
The verification command gcc --version should be in a code block for consistency with the Linux and macOS sections.
🔧 Proposed fix
### Windows
1. Download and install **MinGW-w64** or **TDM-GCC**.
2. During installation, make sure to select the option to add GCC to the system PATH.
3. After installation, open Command Prompt and verify:
-gcc --version
+ ```bash
+ gcc --version
+ ```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Windows | |
| 1. Download and install **MinGW-w64** or **TDM-GCC**. | |
| 2. During installation, make sure to select the option to add GCC to the system PATH. | |
| 3. After installation, open Command Prompt and verify: | |
| gcc --version | |
| ### Windows | |
| 1. Download and install **MinGW-w64** or **TDM-GCC**. | |
| 2. During installation, make sure to select the option to add GCC to the system PATH. | |
| 3. After installation, open Command Prompt and verify: |
🤖 Prompt for AI Agents
In `@README.md` around lines 55 - 59, In the Windows section the verification
command `gcc --version` is not in a code block; update the Windows block (the
"Windows" heading and its bullet list) to wrap the verification command in a
fenced code block (use ```bash on the opening fence and ``` on the closing
fence) so it matches the Linux/macOS formatting and shows the command as code.
1 participant
This PR improves the README by adding clear GCC installation steps
for Windows, Linux, and macOS to help beginners set up GCC easily.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.