github.com/grzegorz-zur/bm@v0.0.0-20240312214136-6fc133e3e2c0/README.md (about)

     1  # Bare Minimum
     2  
     3  Minimalistic text editor.
     4  
     5  ## Status
     6  
     7  [![Actions](https://github.com/grzegorz-zur/bm/workflows/Test/badge.svg)](https://github.com/grzegorz-zur/bm/actions)
     8  [![Go Report Card](https://goreportcard.com/badge/github.com/grzegorz-zur/bm)](https://goreportcard.com/report/github.com/grzegorz-zur/bm)
     9  [![codecov](https://codecov.io/gh/grzegorz-zur/bm/branch/master/graph/badge.svg)](https://codecov.io/gh/grzegorz-zur/bm)
    10  
    11  ## Goals
    12  
    13  1.  Effectively work with multiple files.
    14  2.  Effectively work with external tools that modify edited files.
    15  
    16  ## Installation
    17  
    18  To install or update run the following command.
    19  
    20  ```sh
    21  go get -u github.com/grzegorz-zur/bm
    22  ```
    23  
    24  ## Usage
    25  
    26  ```sh
    27  bm
    28  ```
    29  
    30  ### Command mode
    31  
    32  Execute commands.
    33  
    34  ![command mode](command.svg "Command mode")
    35  
    36  ### Select mode
    37  
    38  Select text and performs operation on the selection
    39  
    40  ![select mode](select.svg "Select mode")
    41  
    42  ### Switch mode
    43  
    44  Type to filter files. Navigate with cursor keys and press enter to select a file.
    45  
    46  ![switch mode](switch.svg "Switch mode")
    47  
    48  ### Input mode
    49  
    50  Type to input text in the current file.
    51  
    52  ![input mode](input.svg "Input mode")