silverstripe-framework/README.md

## Silverstripe Framework

[![CI](https://github.com/silverstripe/silverstripe-framework/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-framework/actions/workflows/ci.yml)
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)

PHP framework forming the base for the Silverstripe CMS ([https://silverstripe.org](https://silverstripe.org)). 
Requires a [`silverstripe-installer`](https://github.com/silverstripe/silverstripe-installer) base project. Typically used alongside the [`cms`](https://github.com/silverstripe/silverstripe-cms) module.

## Installation

See [getting started](https://docs.silverstripe.org/en/getting_started/)
for instructions on how to start the installation process.

## Bugtracker

Bugs are tracked on [github.com](https://github.com/silverstripe/silverstripe-framework/issues). 
Please read our [issue reporting guidelines](https://docs.silverstripe.org/en/contributing/issues_and_bugs/).

## Development and Contribution

If you would like to make changes to the Silverstripe core codebase, we have an extensive [guide to contributing code](https://docs.silverstripe.org/en/contributing/code/).

## Links

 * [Server Requirements](https://docs.silverstripe.org/en/getting_started/server_requirements/)
 * [Changelogs](https://docs.silverstripe.org/en/changelogs/)
 * [Bugtracker: Framework](https://github.com/silverstripe/silverstripe-framework/issues)
 * [Bugtracker: CMS](https://github.com/silverstripe/silverstripe-cms/issues)
 * [Bugtracker: Installer](https://github.com/silverstripe/silverstripe-installer/issues)
 * [Forums](https://forum.silverstripe.org/)
 * [Developer Mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev)
 * [License](./LICENSE)
	
## Attribution

 * Some icons by [Yusuke Kamiyamane](https://p.yusukekamiyamane.com/). All rights reserved. Licensed under a [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
 * default_media.png by Thibault Geffroy from [The Noun Project](https://thenounproject.com/). All rights reserved. Licensed under a [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
MNT Standardise modules 2022-08-01 00:05:19 +02:00			`## Silverstripe Framework`
Build status in README 2012-10-16 18:26:20 +02:00
MNT Add GitHub Actions CI 2022-07-21 04:44:02 +02:00			`[![CI](https://github.com/silverstripe/silverstripe-framework/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-framework/actions/workflows/ci.yml)`
MNT Standardise modules 2022-08-01 00:05:19 +02:00			`[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)`

			`PHP framework forming the base for the Silverstripe CMS ([https://silverstripe.org](https://silverstripe.org)).`
README fix contributing-link, add httpS 2018-04-10 17:54:44 +02:00			Requires a [`silverstripe-installer`](https://github.com/silverstripe/silverstripe-installer) base project. Typically used alongside the [`cms`](https://github.com/silverstripe/silverstripe-cms) module.
MINOR Added README 2011-02-12 02:25:37 +01:00
DOC Update README.md for CMS 5 2023-04-19 06:15:29 +02:00			`## Installation`
MINOR Added README 2011-02-12 02:25:37 +01:00
DOC Update README.md for CMS 5 2023-04-19 06:15:29 +02:00			`See [getting started](https://docs.silverstripe.org/en/getting_started/)`
Update README.md Changed the installation links to getting started as there are no installation pages in the docs for v4. 2022-10-07 05:08:20 +02:00			`for instructions on how to start the installation process.`
MINOR Added README 2011-02-12 02:25:37 +01:00
DOC Update README.md for CMS 5 2023-04-19 06:15:29 +02:00			`## Bugtracker`
Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md. 2012-10-09 01:32:22 +02:00
Fixed broken github issue tracker link 2013-07-04 17:41:53 +02:00			`Bugs are tracked on [github.com](https://github.com/silverstripe/silverstripe-framework/issues).`
DOC remove the version number from docs urls Removing the version number from the links will redirect users to the latest version, as suggested by @michalkleiner 2021-02-01 03:01:04 +01:00			`Please read our [issue reporting guidelines](https://docs.silverstripe.org/en/contributing/issues_and_bugs/).`
Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md. 2012-10-09 01:32:22 +02:00
DOC Update README.md for CMS 5 2023-04-19 06:15:29 +02:00			`## Development and Contribution`
Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md. 2012-10-09 01:32:22 +02:00
MNT Standardise modules 2022-08-01 00:05:19 +02:00			`If you would like to make changes to the Silverstripe core codebase, we have an extensive [guide to contributing code](https://docs.silverstripe.org/en/contributing/code/).`
Broke up contributing docs into 4 sections and unified code contribtion guide. The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md. I've updated this to have separate contributing/code.md page with all the content in a single cohesive page. We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md. 2012-10-09 01:32:22 +02:00
DOC Update README.md for CMS 5 2023-04-19 06:15:29 +02:00			`## Links`
MINOR Added README 2011-02-12 02:25:37 +01:00
DOC remove the version number from docs urls Removing the version number from the links will redirect users to the latest version, as suggested by @michalkleiner 2021-02-01 03:01:04 +01:00			`* [Server Requirements](https://docs.silverstripe.org/en/getting_started/server_requirements/)`
			`* [Changelogs](https://docs.silverstripe.org/en/changelogs/)`
Updated github path 2013-05-17 00:45:52 +02:00			`* [Bugtracker: Framework](https://github.com/silverstripe/silverstripe-framework/issues)`
Contribution guidelines, new bugtracker links 2013-04-02 01:46:36 +02:00			`* [Bugtracker: CMS](https://github.com/silverstripe/silverstripe-cms/issues)`
			`* [Bugtracker: Installer](https://github.com/silverstripe/silverstripe-installer/issues)`
Update link forum 2018-03-20 22:14:23 +01:00			`* [Forums](https://forum.silverstripe.org/)`
MINOR Added README 2011-02-12 02:25:37 +01:00			`* [Developer Mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev)`
FIX: Add separate license file to match module standard. 2017-03-29 01:49:43 +02:00			`* [License](./LICENSE)`
ENHANCEMENT New UploadField class to replace FileIframeField, ImageField and SimpleImageField 2012-02-03 00:59:40 +01:00
DOC Update README.md for CMS 5 2023-04-19 06:15:29 +02:00			`## Attribution`
ENHANCEMENT New UploadField class to replace FileIframeField, ImageField and SimpleImageField 2012-02-03 00:59:40 +01:00
FIX Update .gitattributes and some http:// links (#9805) * Fix .gitattributes * Make some readme links https 2020-12-22 03:57:32 +01:00			`* Some icons by [Yusuke Kamiyamane](https://p.yusukekamiyamane.com/). All rights reserved. Licensed under a [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).`
			`* default_media.png by Thibault Geffroy from [The Noun Project](https://thenounproject.com/). All rights reserved. Licensed under a [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).`