Skip to content

Commit

Permalink
Replace badges in README
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-lerch committed Nov 29, 2021
1 parent cd4917e commit 870c88f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OpenKool

[![](https://images.microbadger.com/badges/image/daniellerch/openkool:r48.svg)](https://microbadger.com/images/daniellerch/openkool:r48 "Get your own image badge on microbadger.com")
[![](https://images.microbadger.com/badges/version/daniellerch/openkool:r48.svg)](https://microbadger.com/images/daniellerch/openkool:r48 "Get your own version badge on microbadger.com")
[![](https://img.shields.io/docker/pulls/daniellerch/openkool.svg)](https://hub.docker.com/r/daniellerch/openkool)
[![](https://img.shields.io/docker/image-size/daniellerch/openkool/r48.svg)](https://hub.docker.com/r/daniellerch/openkool)

This application is a dockerized version of kOOL form [churchtool.org](http://www.churchtool.org).

Expand All @@ -20,4 +20,4 @@ All major upgrades have to be performed manually as they usually ship with break
You cannot skip major upgrades. If you want to upgrade from R45 to R48 for example you have to migrate to R46, R47 and finally to R48.

## Contributing
Contributions are very welcome. Please open an issue to discuss your wishes before implementing them. For setting up a development environment on Windows you will find `install/devenv.ps1` very useful.
Contributions are very welcome. Please open an issue to discuss your wishes before implementing them. For a development environment you will need PHP, XDebug and Visual Studio Code with PHP Intelephense and PHP Debug extensions. On Windows you will find `install/devenv.ps1` very useful and may use [psmodules](https://github.com/daniel-lerch/psmodules) to install a suitable database server.
6 changes: 3 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# OpenKool installation guide

## General setup
1. Download _Compose file_ from the `docs` folder
2. Add your database passwords to the downloaded `docker-compose.yml` file
1. Download `docker-compose.yml` from the `docs` folder
2. Add your database passwords to the downloaded Compose file
3. Download and launch OpenKool
`docker-compose up -d`
4. Run the setup script
Expand All @@ -16,7 +16,7 @@ You can easily migrate your data from an existing kOOL instance to an OpenKool i
1. Create a dump of your existing database
2. Copy the file into the database container
3. Import your database dump
4. Skip database initialization in the web installation wizard
4. Skip database initialization in the web installation wizard (step 6 above)

## Install in a subfolder
It is possible to run OpenKool with a specific path base like https://domain.tld/kool. However, it is not recommended because most of the JavaScript code does not respect custom path bases.
Expand Down

0 comments on commit 870c88f

Please sign in to comment.