Skip to content

Commit d6542fd

Browse files
committed
Updating README.md
1 parent b7de5be commit d6542fd

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ The low level interface is still being mapped out and changes are happening. Thi
3030
- [Extension Commands](#extension-commands)
3131
- [Creating Themes](#creating-themes)
3232
- [Creating Extensions](#creating-extensions)
33+
- [Tutorials on Modal File Manager](#tutorials-on-modal-file-manager)
3334
- [Adding Video Preview on Extra Panel](#adding-video-preview-on-extra-panel)
3435
- [Icon](#icon)
35-
- [Tutorials on Modal File Manager](#tutorials-on-modal-file-manager)
3636

3737
## Philosophy
3838

@@ -56,9 +56,8 @@ I've created multiple open source resources (I have around 80 GitHub repositorie
5656
- Drag and Drop works for copying or moving the current cursor and all selected files or directories (the current cursor location) within the application itself. If no keys pressed, it will be copied. If shift key is pressed, it will be moved. The drag begins with the current cursor.
5757
- Command Prompt for executing commands (`:` in any mode or `<ctrl>p` in normal mode).
5858
- Fully extendable with extensions using the extensions API
59-
- Fully extendable to alternate file systems
6059
- Fully theme-able.
61-
- A file details side panel can be shown to overlay the panel not currently focused (`toggleExtraPanel` command). It shows video previews and stats with the ffmpeg programs installed.
60+
- A file details side panel can be shown to overlay the panel not currently focused (`toggleExtraPanel` command). It shows video previews and stats with the ffmpeg programs installed. Extensions can place special content in this panel as well.
6261
- Themes and extensions are explorable and downloadable from GitHub inside the program.
6362
- Hot keys are programmable
6463
- A number before a hot key runs it's associated command that many times (ex: `5j` will move the cursor 5 entries down the list).
@@ -72,18 +71,20 @@ I've created multiple open source resources (I have around 80 GitHub repositorie
7271
- Change the environment used to execute external programs using the `Show Preferences` Command Prompt command.
7372
- Theme Creator/Editor
7473
- Extension Creator/Editor with template.
75-
- Reloads extensions without relaunching when leaving the Preferences panel.
74+
- Extensions controled content in the Extras Panel.
7675
- Extensions currently created and downloadable from GitHub:
7776
- Favorites: Create a list of favorite directories and quickly jump to them. There is also quick save and jump to directory registers with a new `fav` keyboard mode.
78-
- Copy to Clipboard: copy file name or path to clipboard with command prompt
79-
- Alfred: Launch Afred Browser on the current cursor location
80-
- Move to Dir: Selected files are moved to the folder under the cursor in the same panel
81-
- iTerm: open the current cursor directory in iTerm2
82-
- User Scripts: Create and run scripts from mfm.
77+
- [Copy to Clipboard](https://github.com/raguay/CopyToClipboard-ModalFileManagerExtension): copy file name or path to clipboard with command prompt.
78+
- [Alfred](https://github.com/raguay/Alfred-ModalFileManager): Launch Afred Browser on the current cursor location
79+
- [Move to Dir](https://github.com/raguay/moveToDir-ModalFileManagerExtension): Selected files are moved to the folder under the cursor in the same panel
80+
- [iTerm](): open the current cursor directory in iTerm2
81+
- [Favorites](https://github.com/raguay/Favorites-ModalFileManagerExtension): An extension to mark favorite directories to be able to go back to easily, back up directories previously entered, six directory registers to quickly hop around using the `fav` mode, and much more.
82+
- [User Scripts](https://github.com/raguay/runScripts-ModalFileManagerExtension): Create and run scripts from mfm.
83+
- [Project Manager](https://github.com/raguay/ProjectManager-mfm): A set of functions to work with projects, project templates, run project scripts for npm and mask, and creating/editing of project notes.
8384
- Themes currently created and downloadable from GitHub:
84-
- Dracula Pro
85-
- Dracula "Buffy"
86-
- Dracula "Van Helsing"
85+
- [Dracula Pro](https://github.com/raguay/dracula-ThemeModalFileManager)
86+
- [Dracula "Buffy"](https://github.com/raguay/dracula-buffy-ThemeModalFileManager)
87+
- [Dracula "Van Helsing"](https://github.com/raguay/Dracula-Van-Helsing-ThemeModalFileManager)
8788

8889
All Dracula based themes are here with permission from the author. Please support his great work at [Dracula Themes](https://draculatheme.com/). The Dracula "Buffy" theme is my preferred theme for everything. I'm having many issues with my eyes having light sensitivity and this theme allows me to keep working longer than other themes.
8990

@@ -124,7 +125,7 @@ mask launch -d
124125

125126
which will launch the sdk version of NW.js with full development tools.
126127

127-
If you just want to download a program to use, check the releases. I'm currently releasing beta level macOS binaries in the releases.
128+
If you just want to download a program to use, check the releases. I'm currently releasing beta level macOS binaries in the releases. A step by step installing using the releases is discussed in my tutorial [Modal File Manager: Update and Extensions](https://blog.customct.com/modal-file-manager-update-and-extensions).
128129

129130
## Upgrading
130131

@@ -148,13 +149,13 @@ All extensions, themes, keyboard layouts, and anything else for configuring the
148149

149150
In this configuration directory, there are the `themes`, `extensions`, and `keyMaps` directories that contain their respective subfolders and files. Please refer the specific section for each directory for more details.
150151

151-
There is the `history.json` file, `config.json` file, and the `theme.json` files in the configuration directory.
152+
There is the `history.json` file, `config.json` file, and the `theme.json` files in the configuration directory. Also, extensions will create and store their configuration files in this directory as well (at least, that is what I advise extension authors).
152153

153154
The `history.json` file contains a list of directories that the Modal File Manager has visited. I use this to quickly pull up possible paths to go to in the file manager.
154155

155156
The `config.json` file contains the environment variables used to launch command line commands and whether or not to use the `trash-cli` program to delete files and directories.
156157

157-
Modal File Manager doesn't use the actual theme files downloaded from GitHub. Those are stored in the `themes` directory and are just referenced. All actually used theming is in the `theme.json` file. When a user changes themes, that file is changed. Therefore, be careful if you manually change this file and want to keep it. It is best to create a theme in the theme directory and load it in the program.
158+
Modal File Manager doesn't use the actual theme files downloaded from GitHub. Those are stored in the `themes` directory and are just referenced. All actually used theming is in the `theme.json` file. When a user changes themes, that file is changed. Therefore, be careful if you manually change this file and want to keep it. It is best to create a theme in the theme directory and load it in the program. My tutorial [Modal File Manager: Update and Extensions](https://blog.customct.com/modal-file-manager-update-and-extensions) walks through creating a theme using the Preferences Panel.
158159

159160
All configuration files should be edited from the `Show Preferences` command prompt command.
160161

@@ -193,15 +194,13 @@ With the command prompt command of `Show Preferences`, you can now open a new pa
193194

194195
The General tab allows the user to delete, edit, or add environment variables to the running of command line programs. This give the user complete control over the environment variables used in launching commands from Modal File Manager. You can also turn on/off the use of the trashcan for deletions.
195196

196-
The Theme tab allows you to create, update, and delete themes from the Modal File Manager.
197+
The Theme tab allows you to create, update, and delete themes from the Modal File Manager. My tutorial [Modal File Manager: Update and Extensions](https://blog.customct.com/modal-file-manager-update-and-extensions) walks through creating a theme using the Preferences Panel.
197198

198199
The Extension tab allows you to create, edit, and delete extensions from the Modal File Manager. The creation and editing of an extension will open the main file for the extension in the code editor that has been setup and moves the Modal File Manager to the extension's directory in the pane opposite the current cursor.
199200

200201
## Things in the Works
201202

202203
- Translating my fman extensions to work with Modal File Manager
203-
- Project Manager
204-
- Notes - Should be part of Project Manager?
205204
- Dropbox File System
206205
- Regular Expression selection
207206
- Zip Selected Entries
@@ -211,7 +210,6 @@ The Extension tab allows you to create, edit, and delete extensions from the Mod
211210
- Get Windows working
212211
- Get Linux tested and working
213212
- Get audio listening in the Extras Panel.
214-
- Extensions controled content in the Extras Panel.
215213
- Documentation!
216214
- Of course, bug fixing!
217215

@@ -411,6 +409,11 @@ It should be a proper JSON structure with these definitions. Change the color va
411409

412410
TODO: Documentation Coming Soon.
413411

412+
## Tutorials on Modal File Manager
413+
414+
- [My Side Project: Modal File Manager](https://blog.customct.com/my-side-project-modal-file-manager)
415+
- [Modal File Manager: Update and Extensions](https://blog.customct.com/modal-file-manager-update-and-extensions)
416+
414417
## Adding Video Preview on Extra Panel
415418

416419
The normal copy of NW.js doesn't come with the codeces for displaying videos. In order for this feature, you will have to download the dynamically loaded library for your system from here: https://github.com/iteufel/nwjs-ffmpeg-prebuilt/releases.
@@ -425,8 +428,4 @@ I finally made my first attempt at an icon for Modal File Manager. The files are
425428

426429
![Icon](icons/mfm-icon.svg)
427430

428-
## Tutorials on Modal File Manager
429-
430-
- [My Side Project: Modal File Manager](https://blog.customct.com/my-side-project-modal-file-manager)
431-
- [Modal File Manager: Update and Extensions](https://blog.customct.com/modal-file-manager-update-and-extensions)
432431

0 commit comments

Comments
 (0)