From 6b17cf57192a8660162099a39818616590a275b5 Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Fri, 10 Nov 2017 05:07:48 +0400 Subject: Added instruction --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 1f37871..8fc02f1 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,41 @@ Automatic build and deployment of the package `mednafen-server`. +## General use + Installation packages are available in the [release](https://github.com/valentineus/mednafen-server/releases) section. +After downloading the package, perform the installation: +```bash +# dpkg --install mednafen-server_*_amd64.deb +``` + +Starting the server: +```bash +# mednafen-server standard.conf +``` + +An example of the configuration file is in the repository. +Detailed information is available on the +[developer's website](https://mednafen.github.io/releases/#mednafen-server). + +## Docker use + +* Download the image: +```bash +$ docker pull valentineus/mednafen-server:latest +``` + +* Start the container: +```bash +$ docker run --detach --restart=unless-stopped --publish 4046:4046 --name "mednafen-server" valentineus/mednafen-server +``` + +More information on the +[image page](https://hub.docker.com/r/valentineus/mednafen-server/). + ## License GNU Banner -- cgit v1.2.3