Update 'README.md'

This commit is contained in:
Johan Koke 2022-08-18 08:24:26 +00:00
parent 56b86ad91b
commit 41b0b9899c
1 changed files with 59 additions and 0 deletions

View File

@ -0,0 +1,59 @@
# Project Title
A short description about the project and/or client.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
The things you need before installing the software.
* You need this
* And you need this
* Oh, and don't forget this
### Installation
A step by step guide that will tell you how to get the development environment up and running.
```
$ git clone https://git.koke.estate/Docker/Minecraft-Bedrock.git
$ cp sample.env .env
$ nano .env
```
## Usage
A few examples of useful commands and/or tasks.
```
$ First example
$ Second example
$ And keep this in mind
```
## Deployment
Additional notes on how to deploy this on a live or release system. Explaining the most important branches, what pipelines they trigger and how to update the database (if anything special).
### Server
* Live:
* Release:
* Development:
### Branches
* Master:
* Feature:
* Bugfix:
* etc...
## Additional Documentation and Acknowledgments
* Project folder on server:
* Confluence link:
* Asana board:
* etc...