diff --git a/README.md b/README.md index 95e5d7b..bdd2618 100755 --- a/README.md +++ b/README.md @@ -1,19 +1,68 @@ -# DinguxCommander +OD Commander is forked from DinguxCommander which is a file manager for RetroFW. +It uses two vertical panels side by side, one being the source and the other the destination, like many 'commander-style' file managers such as Norton Commander or Midnight Commander. -DinguxCommander is a file manager for RetroFW. -It uses two vertical panels side by side, one being the source and the other the -destination, like many 'commander-style' file managers such as Norton Commander -or Midnight Commander. DinguxCommander allows to: * Copy, move and delete multiple files. * View a file * Execute a file +* Edit a file one line at the time * Rename a file or directory * Create a new directory * Display disk space used by a list of selected files/dirs * Display disk information (used, available, total) + +## Controls + +* D-pad\ + Move cursor/highlight + +* L/R\ + Page up/page down + +* A\ + On a directory: Open + On a file: View or execute + +* B\ + Go to parent directory or cancel + +* X\ + Opens a menu with actions on selected item(s): + - Copy (to destination directory) + - Move (to destination directory) + - Rename (appears only if 1 item is selected) + - Delete + - Display disk used + +* Y\ + Opens system actions menu: + - Select all items + - Select no items + - Create new directory + - Display disk information + - Quit program + +* SELECT\ + Select highlighted item (selected items are displayed in red) + +* START\ + Open highlighted directory in destination panel\ + If a file is highlighted, open current directory in destination panel + +## Settings + +For instance to change the UI/font size on e.g. Steam Deck create a file called commander.cfg in ~/.config/ (also called $HOME/.config/) with these settings in it: + +``` +disp_autoscale_dpi=0 +disp_ppu_x=2.5 +disp_ppu_y=2.5 +``` +You can find other settings in this source file: +https://github.com/od-contrib/commander/blob/079a84c8a8cc25e1899cb11bcfce8e9e2ed9fca9/config.h + ## Building To build for RetroFW, run: @@ -35,35 +84,13 @@ To build for the host system, run: ```bash ./build-host.sh ``` - -## Controls - - -* D-pad Move -* L/R Page up/page down -* A For a directory: open - For a file: view or execute -* B Go to parent directory / cancel -* Y System actions: - - Select all items - - Select no items - - Create new directory - - Display disk information - - Quit program -* X Actions on selected items: - - Copy to destination directory - - Move to destination directory - - Rename (appears only if 1 item is selected) - - Delete - - Display disk used -* SELECT Select highlighted item. - Selected items are displayed in red. -* START Open highlighted directory in destination panel. - If a file is highlighted, open current directory in destination panel. - - -## Credits - -Homepage: http://beyondds.free.fr/ -Development: Mia -Font: Beycan Çetin + +## DinguxCommander credits + +- Development\ + Mia\ + http://beyondds.free.fr + https://tardigrade-nx.github.io + +- Font\ + Beycan Çetin