Skip to content

Commit 31876ca

Browse files
Updating readme for credits and also reformatting it a little bit
1 parent 2cf9d10 commit 31876ca

1 file changed

Lines changed: 26 additions & 6 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
# Filemanager Plugin
22

3+
> This is a fork from https://codeberg.org/micro-plugins/filemanager2
4+
> and will continue to be maintained as much as possible
5+
> All credits and previous efforts goes to [Nicolai Søborg](https://github.com/NicolaiSoeborg),
6+
[ryo-inagaki](https://github.com/ryo-inagaki) and [taconi](https://github.com/taconi)
7+
38
A simple plugin that allows for easy navigation of a file tree.
49

5-
This plugin contains the same functionality as [filemanager](https://github.com/micro-editor/updated-plugins/tree/master/filemanager-plugin), but with the commands 'rename', 'touch' and 'mkdir' working in micro v2. The adjustment of these commands was done by [Ryo Inagaki](https://github.com/ryo-inagaki/) and there is already a [Pull Request](https://github.com/micro-editor/updated-plugins/pull/10) however, PR's are not accepted for a while (there is an [issue](https://github.com/micro-editor/plugin-channel/issues/74) on this subject). This repository was created to make available the commands working, as soon as the pull request is accepted, this repository will be archived and deleted after a while.
10+
This plugin contains the same functionality as
11+
[filemanager](https://github.com/micro-editor/updated-plugins/tree/master/filemanager-plugin),
12+
but with the commands 'rename', 'touch' and 'mkdir' working in micro v2.
13+
The adjustment of these commands was done by [Ryo Inagaki](https://github.com/ryo-inagaki/) and
14+
there is already a [Pull Request](https://github.com/micro-editor/updated-plugins/pull/10)
15+
however, PR's are not accepted for a while (there is an
16+
[issue](https://github.com/micro-editor/plugin-channel/issues/74) on this subject).
17+
This repository was created to make available the commands working, as soon as the pull request
18+
is accepted, this repository will be archived and deleted after a while.
619

720
![Example picture](./assets/example.jpg?raw=true "Example")
821

@@ -13,7 +26,8 @@ If [nerd fonts](https://www.nerdfonts.com) is installed and options `filemanager
1326
## Installation
1427

1528
### Settings
16-
Add this repo as a **pluginrepos** option in the **~/.config/micro/settings.json** file (it is necessary to restart the micro after this change):
29+
Add this repo as a **pluginrepos** option in the **~/.config/micro/settings.json** file
30+
(it is necessary to restart the micro after this change):
1731
```json
1832
{
1933
"pluginrepos": [
@@ -40,9 +54,12 @@ The top line always has the current directory's path to show you where you are.\
4054
The `..` near the top is used to move back a directory, from your current position.
4155

4256
All directories have a `/` added to the end of it, and are syntax-highlighted as a `special` character.\
43-
If the directory is expanded, there will be a `+` to the left of it. If it is collapsed there will be a `-` instead.
4457

45-
**NOTE:** If you change files without using the plugin, it can't know what you did. The only fix is to close and open the tree.
58+
If the directory is expanded, there will be a `+` to the left of it.
59+
If it is collapsed there will be a `-` instead.
60+
61+
**NOTE:** If you change files without using the plugin, it can't know what you did.
62+
The only fix is to close and open the tree.
4663

4764
### Options
4865

@@ -57,9 +74,12 @@ If the directory is expanded, there will be a `+` to the left of it. If it is co
5774

5875
### Commands and Keybindings
5976

60-
The keybindings below are the equivalent to Micro's defaults, and not actually set by the plugin. If you've changed any of those keybindings, then that key is used instead.
77+
The keybindings below are the equivalent to Micro's defaults, and not actually set by the plugin.
78+
If you've changed any of those keybindings, then that key is used instead.
6179

62-
If you want to [keybind](https://github.com/zyedidia/micro/blob/master/runtime/help/keybindings.md#rebinding-keys) any of the operations/commands, bind to the labeled API in the table below.
80+
If you want to
81+
[keybind](https://github.com/zyedidia/micro/blob/master/runtime/help/keybindings.md#rebinding-keys)
82+
any of the operations/commands, bind to the labeled API in the table below.
6383

6484
| Command | Keybinding(s) | What it does | API for `bindings.json` |
6585
| :------- | :------------------------- | :------------------------------------------------------------------------------------------ | :------------------------------------ |

0 commit comments

Comments
 (0)