diff --git a/README.md b/README.md index 03ff4c7..a1f834b 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,21 @@ This is mostly a "fun project" and consists mostly of code I already wrote. # Usage +Make the following directories where you will run retrovnc in: + +- `config` +- `system` +- `save` + +These folders are used either by retrovnc or cores to store data. + +For the most basic usecase: + `$ retrovnc --core --rom ` (see `retrovnc --help` for more options) -For disc-based titles it is probably a good idea to pass the cuesheet file. I will implement stuff later to make this less annoying. +E.g: to use swanstation (assuming you have placed requirements in the system folder): +`retrovnc --core cores/swanstation_libretro.so --rom roms/my_game.cue` +After launching a core for the first time, a TOML file in config/ is created to allow you to set core options. You may use this file to set any option given by the core.