Skip to content

Commit

Permalink
Merge pull request #139 from creative-commoners/pulls/5.0/cms5-readme
Browse files Browse the repository at this point in the history
DOC Update README.md for CMS 5
  • Loading branch information
sabina-talipova authored Apr 25, 2023
2 parents 2e9cfdc + c2be6ee commit 5ca17ba
Showing 1 changed file with 10 additions and 28 deletions.
38 changes: 10 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,41 +8,23 @@
SiteConfig provides a `Settings` tab in the admin section allowing users to set
site wide global configuration.

## Requirements

* Silverstripe 3.2

## Installation

Installation can be done either by composer or by manually downloading the
release from Github.

### Via composer

`composer require "silverstripe/siteconfig:*"`

### Manually

1. Download the module from [the releases page](https://github.com/silverstripe/silverstripe-siteconfig/releases).
2. Extract the file (if you are on windows try 7-zip for extracting tar.gz files
3. Make sure the folder after being extracted is named 'siteconfig'
4. Place this directory in your sites root directory. This is the one with framework and cms in it.
```sh
composer require silverstripe/siteconfig
```

### Configuration
## Configuration

After installation, make sure you rebuild your database through `dev/build`.

## Development and Contribution ##
## Development and Contribution

If you would like to make changes to the Silverstripe core codebase, we have an extensive [guide to contributing code](http://doc.silverstripe.org/framework/en/misc/contributing/code).
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/4/contributing/code/).

## Links ##
## Links

* [Requirements](http://doc.silverstripe.org/framework/en/installation/server-requirements)
* [Changelogs](http://doc.silverstripe.org/framework/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](http://silverstripe.org/forums)
* [Developer Mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev)
* [Requirements](https://docs.silverstripe.org/en/4/getting_started/server_requirements/)
* [Changelogs](https://docs.silverstripe.org/framework/en/changelogs/)
* [Forums](https://forum.silverstripe.org/)
* [License](./LICENSE)

0 comments on commit 5ca17ba

Please sign in to comment.