malhuda/CodeIgniter4
1
0
Fork 0
mirror of https://github.com/codeigniter4/CodeIgniter4.git synced 2025-02-20 11:44:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix readme markdown styling

Browse Source
This commit is contained in:
Jim Parry 2019-01-17 23:44:21 -08:00
parent 6afcadcb5e
commit 1aee735f86
No known key found for this signature in database
GPG Key ID: CED549230775AD5B
4 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -5,6 +5,7 @@
<br>
## What is CodeIgniter?
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure.
More information can be found at the [official site](http://codeigniter.com).
@ -35,6 +36,7 @@ framework are exposed.
The user guide updating and deployment is a bit awkward at the moment, but we are working on it!
## Repository Management
We use Github issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
FEATURE REQUESTS.
@ -57,6 +59,7 @@ Remember that some components that were part of CodeIgniter 3 are being moved
to optional packages, with their own repository.
## Contributing
We **are** accepting contributions from the community, specifically those identified as part of phase 2.
We will try to manage the process somewhat, by adding a "Help wanted" label to those that we are
@ -68,6 +71,7 @@ We are not looking for out-of-scope contributions, only those that would be cons
Please read the [*Contributing to CodeIgniter*](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing.md) section in the user guide
## Server Requirements
PHP version 7.1 or higher is required, with the following extensions installed:
- [intl](http://php.net/manual/en/intl.requirements.php)
@ -81,4 +85,5 @@ Additionally, make sure that the following extensions are enabled in your PHP:
- xml (enabled by default - don't turn it off)
## Running CodeIgniter Tests
Information on running CodeIgniter test suite can be found in the [README.md](tests/README.md) file in the tests directory.

12
admin/README.md
View File

@ -1,8 +1,8 @@
#CodeIgniter 4 Admin
# CodeIgniter 4 Admin
This folder contains tools or docs useful for project maintainers.
##Repositories inside https://github.com/codeigniter4
## Repositories inside https://github.com/codeigniter4
- **CodeIgniter4** is the main development repository.
It supports issues and pull requests, and has a rule to enforce GPG-signed commits.
@ -35,7 +35,7 @@ This folder contains tools or docs useful for project maintainers.
It is community-maintained, and accepts issues and pull requests.
It could be downloaded, forked or composer-installed.
##Contributor Scripts
## Contributor Scripts
- **setup.sh** installs a git pre-commit hook into a contributor's
local clone of their fork of the `CodeIgniter4` repository.
@ -43,7 +43,7 @@ This folder contains tools or docs useful for project maintainers.
to be added as part of a git commit, ensuring that they conform to the
framework coding style standards, and automatically fixing what can be.
##Maintainer Scripts
## Maintainer Scripts
- **release-config** holds variables used for the maintainer & release building
- **docbot** re-builds the user guide from the RST source for it,
@ -51,7 +51,7 @@ This folder contains tools or docs useful for project maintainers.
repository (if the user running it has maintainer rights on that repo).
See the [writeup](./docbot.md).
##Release Building Scripts
## Release Building Scripts
The release workflow is detailed in its own writeup; these are the main
scripts used by the release manager:
@ -79,7 +79,7 @@ scripts used by the release manager:
Remember to be polite when running it.
##Other Stuff
## Other Stuff
- **release-notes.bb** is a boilerplate for forum announcements of a new release.
It is marked up using [BBcode](https://en.wikipedia.org/wiki/BBCode).

4
admin/framework/README.md
View File

@ -1,6 +1,7 @@
# CodeIgniter 4 Framework
## What is CodeIgniter?
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure.
More information can be found at the [official site](http://codeigniter.com).
@ -29,6 +30,7 @@ framework are exposed.
The user guide updating and deployment is a bit awkward at the moment, but we are working on it!
## Repository Management
We use Github issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
FEATURE REQUESTS.
@ -51,11 +53,13 @@ Remember that some components that were part of CodeIgniter 3 are being moved
to optional packages, with their own repository.
## Contributing
We welcome contributions from the community.
Please read the [*Contributing to CodeIgniter*](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing.md) section in the development repository.
## Server Requirements
PHP version 7.1 or higher is required, with the following extensions installed:
- [intl](http://php.net/manual/en/intl.requirements.php)

1
admin/userguide/README.md
View File

@ -1,6 +1,7 @@
# CodeIgniter 4 User Guide
## What is CodeIgniter?
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure.
More information can be found at the [official site](http://codeigniter.com).