funkey/RetroFE
1
0
Fork 0
mirror of https://github.com/FunKey-Project/RetroFE.git synced 2026-03-24 04:42:52 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adding configuration GUI and sphinx documentation to repository.

Browse Source
This commit is contained in:
emb
2015-01-03 22:47:53 -06:00
parent 44745f0fd2
commit 9f6ddde34c
69 changed files with 5572 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/Manual/Installation.rst Normal file
View File

@@ -0,0 +1,26 @@
Installation
####################
Setting up a base installation can be done by performing the following steps:
Overview
------------------------------------------
#. Unzip RetroFE
#. Edit your Settings.conf
#. Setup your launchers (emulators)
#. Setup your collections (game lists)
#. Edit your Collections/Main/Menu.xml
#. Run RetroFE.exe
Details
------------------------------------------
#. Extract the contents of the frontend to a folder of your choosing.
#. Edit your :ref:`Configuration` file (/Settings.conf)
#. Setup your launchers (emulators) (/Launchers/\*.conf)
#. Setup your collections (game lists) for your games. (/Collections/<collection>/\*.conf)
#. Edit your main menu (Collections/Main/Menu.xml) to show what collections show up on the front page.
#. Run RetroFE.exe
It is recommended that you organize your assets (games, artwork, videos, etc...) prior to configuring. After getting your system up and running you can download additional layouts or create your own layout (see :ref:`Layouts` for instructions on how to create your own layout).