aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentin Popov <info@valentineus.link>2017-11-10 04:07:48 +0300
committerValentin Popov <info@valentineus.link>2017-11-10 04:07:48 +0300
commit6b17cf57192a8660162099a39818616590a275b5 (patch)
tree1c6018e597a11c5e8e2b5c54aad45a4019ee6a92
parente411d6d8f4f0bff623bc93d6d92b1bc872393350 (diff)
downloadmednafen-server-6b17cf57192a8660162099a39818616590a275b5.tar.xz
mednafen-server-6b17cf57192a8660162099a39818616590a275b5.zip
Added instruction
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
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
<img height="256px" alt="GNU Banner" src="https://www.gnu.org/graphics/runfreegnu.png" />