docs(readme): revamp overview, quick start, and contribution links#9800
docs(readme): revamp overview, quick start, and contribution links#9800Richin wants to merge 1 commit intocodeigniter4:developfrom
Conversation
|
Hi there, Richin! 👋 Thank you for sending this PR! We expect the following in all Pull Requests (PRs).
Important We expect all code changes or bug-fixes to be accompanied by one or more tests added to our test suite to prove the code works. If pull requests do not comply with the above, they will likely be closed. Since we are a team of volunteers, we don't have any more time to work See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/pull_request.md Sincerely, the mergeable bot 🤖 |
Richin
force-pushed
the
revamp-readme-file
branch
from
fc78b2b to
0717678
Compare
| [](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/test-phpstan.yml) | ||
| [](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/test-psalm.yml) | ||
| [](https://coveralls.io/github/codeigniter4/CodeIgniter4?branch=develop) | ||
| [](https://packagist.org/packages/codeigniter4/framework) | ||
| [](https://packagist.org/packages/codeigniter4/framework) | ||
| [](https://packagist.org/packages/codeigniter4/framework) | ||
| [](https://github.com/codeigniter4/CodeIgniter4/blob/develop/LICENSE) | ||
| [](https://github.com/codeigniter4/CodeIgniter4/pulls) |
There was a problem hiding this comment.
Why do you remove these badges?
| 1. **Clone and install dependencies** | ||
| ```bash | ||
| git clone https://github.com/codeigniter4/CodeIgniter4.git | ||
| cd CodeIgniter4 | ||
| composer install | ||
| ``` |
There was a problem hiding this comment.
This step is for contributors only to the framework development. As such, this is not the go to way of installing this.
|
Please be aware that you are editing the README applicable for the development repository. If you are intending to revamp the README for the framework, you might want to go to |
|
👋 Hi, @Richin! |
2 participants
Rewrite README.md to provide a clearer overview of CodeIgniter 4, including key framework features, requirements, and community resources.
Add a pragmatic quick-start section with Windows-specific notes, highlight common spark/Composer workflows, and outline the project structure so newcomers can get productive quickly.
Clarify contribution and security guidance by linking to the relevant docs.
Checklist: