[PR #1527] [CLOSED] update README with GPLv3 license and badges #2137

Open
opened 2026-01-29 15:29:22 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/TheAlgorithms/C/pull/1527
Author: @ABHIRANJAN-KUMAR1
Created: 11/7/2025
Status: Closed

Base: masterHead: patch-1


📝 Commits (1)

  • 40ea117 update README with GPLv3 license and badges

📊 Changes

1 file changed (+60 additions, -24 deletions)

View changed files

📝 README.md (+60 -24)

📄 Description

Updated README.md to improve clarity, usability, and licensing information.

License

  • Added GNU General Public License v3.0 (GPLv3) section.
  • Clarified user permissions and contributor obligations.

Documentation & Structure

  • Added badges for Gitpod, CI, chat, and donations.
  • Included a Table of Contents for easy navigation.
  • Reorganized sections: Overview, Features, Documentation, Installation, Quick Start, Algorithm Categories, Contributions, FAQ, License.

Examples & Instructions

  • Provided installation steps for cloning and compiling C programs.
  • Added a quick start example (Bubble Sort) with compilation and execution instructions.

Formatting & Readability

  • Improved markdown formatting for better readability.
  • Ensured all links and badges are functional.
  • Made README copy-paste friendly for users and contributors.

Contribution Guidelines

  • Included steps for branching, committing, and creating pull requests.

This commit makes README fully ready for users and contributors, ensuring clear guidance and legal clarity under GPLv3.

Description of Change

References

Checklist

  • Added description of change
  • Added file name matches File name guidelines
  • Added tests and example, test must pass
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes:


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/TheAlgorithms/C/pull/1527 **Author:** [@ABHIRANJAN-KUMAR1](https://github.com/ABHIRANJAN-KUMAR1) **Created:** 11/7/2025 **Status:** ❌ Closed **Base:** `master` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`40ea117`](https://github.com/TheAlgorithms/C/commit/40ea1175b1a340be18105bc88dc992500fe691f1) update README with GPLv3 license and badges ### 📊 Changes **1 file changed** (+60 additions, -24 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+60 -24) </details> ### 📄 Description Updated README.md to improve clarity, usability, and licensing information. **License** - Added GNU General Public License v3.0 (GPLv3) section. - Clarified user permissions and contributor obligations. **Documentation & Structure** - Added badges for Gitpod, CI, chat, and donations. - Included a Table of Contents for easy navigation. - Reorganized sections: Overview, Features, Documentation, Installation, Quick Start, Algorithm Categories, Contributions, FAQ, License. **Examples & Instructions** - Provided installation steps for cloning and compiling C programs. - Added a quick start example (Bubble Sort) with compilation and execution instructions. **Formatting & Readability** - Improved markdown formatting for better readability. - Ensured all links and badges are functional. - Made README copy-paste friendly for users and contributors. **Contribution Guidelines** - Included steps for branching, committing, and creating pull requests. This commit makes README fully ready for users and contributors, ensuring clear guidance and legal clarity under GPLv3. #### Description of Change <!-- Thank you for your Pull Request. Please provide a description above and review the requirements below. Contributors guide: https://github.com/TheAlgorithms/C/blob/master/CONTRIBUTING.md --> #### References <!-- Add any reference to previous pull-request or issue --> #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [ ] Added description of change - [ ] Added file name matches [File name guidelines](https://github.com/TheAlgorithms/C/blob/master/CONTRIBUTING.md#File-Name-guidelines) - [ ] Added tests and example, test must pass - [ ] Relevant documentation/comments is changed or added - [ ] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C/blob/master/CONTRIBUTING.md#Commit-Guidelines) - [ ] Search previous suggestions before making a new one, as yours may be a duplicate. - [ ] I acknowledge that all my contributions will be made under the project's license. Notes: <!-- Please add a one-line description for developers or pull request viewers --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 15:29:22 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/C#2137