Add quick guide to readme.

This commit is contained in:
J-D-K 2020-04-18 23:00:37 -04:00
parent 53d839101c
commit e18c381a05

View File

@ -19,11 +19,47 @@ JKSV on Switch started as a small project/port to test some things and get famil
* Mount and open RomFS of process the homebrew menu takes over (if launched as NRO) (To be re-added later)
* Hold R while opening a game or applet with Atmosphere so the homebrew menu loads. Open JKSV and press minus and select **Mount Process RomFS**. The romfs of the app should appear in the browser along with your SD on the right.
# Building:
## Quick Guide
1. User Select
* A opens the selected user's save files.
* Y Dumps __all__ save data from __all users__, device save data, and BCAT save data. System save data is not included in this.
* X Changes the UI mode to a text menu based one for people that prefer 3DS JKSM style text menus instead.
* ZR Opens the Options menu.
* Minus opens a small menu of extras.
2. Title Select
* A Opens the title for backup and restore.
* L and R change the current user.
* Y Dumps all saves for the currently selected user.
* X Adds the selected title to a list of ignored titles.
* Minus adds the selected title to a list of favorites that are pushed to the top of the title list/icons.
* ZR __ERASES__ The selected title's save from the system. This is the same as going into settings and deleting via data management. __THIS DOES NOT DELETE JKSV's SAVE FOLDERS__.
3. Backup/Folder Menu
* Minus opens file mode. File mode is a basic file browser for moving individual files and folders. This also adds the ability to restore saves from any location on your SD card.
* Holding L or R while selecting new with A will automatically name the backup for you without opening the keyboard.
* A creates a new backup
* Y Restores save data from the selected folder.
* X Deletes the selected folder.
* ZR __ERASES__ the current save data for the title from __your system__, but leaves the archive on NAND.
4. File Mode
* A opens directories.
* B goes back up a folder if possible.
* X opens a small menu of options for files and directories:
* Copy to [X] - Copies the currently selected item to the location opened on the other panel. Selecting the first `.` will use the directory opened as root to copy.
* Delete deletes the currently selected item.
* Rename renames the currently selected item.
* Make Dir creates a folder.
* Properties gets file size and directory size.
* ZL or ZR Change the controlled menu.
## Building:
1. Requires [devkitPro](https://devkitpro.org/) and [libnx](https://github.com/switchbrew/libnx)
2. Requires switch-freetype, libpng, and libjpeg-turbo
# Credits and Thanks:
## Credits and Thanks:
* [shared-font](https://github.com/switchbrew/switch-portlibs-examples) example by yellows8
* Authors of switch-examples for account and save mounting code.
* [Iguniisu](https://github.com/igniscitrinus) for the icon.