diff --git a/README.md b/README.md index df5e708..611aa09 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # CTFd Theme Repository -This repository gathers open source CTFd themes from around the internet. Official premium themes can be found on the [CTFd Store](https://ctfd.io/store). +This repository gathers open source CTFd themes from around the internet. Official premium themes can be found on the [CTFd Store](https://ctfd.io/store). -Each theme provided here is stored as a gitsubmodule to the theme's project repository. +Take note that these themes are not officially supported and might be using outdated code. Thoroughly inspect the theme for bugs before an event to prevent any interruptions. + +If you don't have time to edit and customize themes, [Contact us](https://ctfd.io/contact/) and we'll help you create a custom CTFd theme. # Installation CTFd will automatically treat folders in the [CTFd/themes](https://github.com/CTFd/CTFd/tree/master/CTFd/themes) folder as themes to load. -You can clone this repository and then copy or symlink the theme folders you wish to use to the [CTFd/themes](https://github.com/CTFd/CTFd/tree/master/CTFd/themes) folder. +You can clone this repository and then copy or symlink the theme folders you wish to use to the [CTFd/themes](https://github.com/CTFd/CTFd/tree/master/CTFd/themes) folder. + +Each theme provided here is stored as a gitsubmodule to the theme's project repository. Because gitsubmodules are used, to clone this repository properly you should use the following command: