lite-xl/README_OS4.md

# Lite XL v2 for AmigaOS 4.1 FE

Lite XL is a lightweight text editor written in Lua.

## Installation
You can extract the Lite XL archive wherever you want and run the *lite* 
editor.

## Configuration folder
This editor creates a `.config` folder where the configuration is saved, as 
well as plugins, themes etc.. By default this AmigaOS 4.1 FE version uses the
executable folder, but if you want to ovveride it, create an ENV variable 
named `HOME` and set there your path. 

You can check if there is one already set by executing the following command
in a shell
```
GetEnv HOME
```
If there is one set, then you will see the path at the output.

Otherwise, you can set your home path be executing the following command. 
Change the path to the one of your preference.
```
SetEnv SAVE HOME "Sys:home/"
```

## Addons
### Colors
Colors are lua files that set the color scheme of the editor. There are
light and dark themes for you to choose. 

To install and use them you have to copy the ones you would like from
`addons/colors/light` or `addons/colors/dark` into the folder
`.config/lite-xl/colors/`. Don't add light or dark folders. Just copy the
.lua files in there.

Then you have to start Lite XL and open your configuration by clicking
at the cog icon at the toolbar (bottom left sixth icon). Go at the line
that looks like below
```
-- core.reload_module("colors.summer")
``` 
and change the `summer` with the name of your color theme. Also, remove
the two dashes `--` at the start of the line and save the file. If you
did everything right, the color schema should change instantly.

The themes can also be found at 
https://github.com/lite-xl/lite-xl-colors

### Plugins
The Lite XL that you are using on AmigaOS 4 is based on version 1.16.12
and not the latest version that is available by the development team. 
This means that the latest plugins are not working at all or need some
modifications to work.

To make it easier for you, I gathered some of the plugins that are working
well, and I included them at the `addons/plugins`. For you to install the
ones you would like to use, you have to copy the `.lua` files into the
folder `.config/lite-xl/plugins/` and restart the editor.

The included plugins are the following:

**autoinsert**
Automatically inserts closing brackets and quotes. Also allows selected 
  text to be wrapped with brackets or quotes.

**autowrap**
Automatically hardwraps lines when typing

**bigclock**
Shows the current time and date in a view with large text

**bracketmatch**
Underlines matching pair for bracket under the caret

**colorpreview**
Underlays color values (eg. `#ff00ff` or `rgb(255, 0, 255)`) with their 
resultant color.

**eofnewline-xl**
Make sure the file ends with one blank line.

**ephemeral_tabs**
Preview tabs. Opening a doc will replace the contents of the preview tab.
Marks tabs as non-preview on any change or tab double clicking.

**ghmarkdown**
Opens a preview of the current markdown file in a browser window 

**indentguide**
Adds indent guides

**language_make**
Syntax for the Make build system language

**language_sh**
Syntax for shell scripting language

**lfautoinsert**
Automatically inserts indentation and closing bracket/text after newline

**markers**
Add markers to docs and jump between them quickly

**navigate**
Allows moving back and forward between document positions, reducing the 
amount of scrolling

**rainbowparen**
Show nesting of parentheses with rainbow colours

**restoretabs**
Keep a list of recently closed tabs, and restore the tab in order on 
cntrl+shift+t.

**selectionhighlight**
Highlights regions of code that match the current selection

## Tips and tricks

### Transitions

If you want to disable the transitions and make the scrolling a little faster,
open your configuration by clicking at the cog icon at the toolbar 
(bottom left sixth icon) and add the followline at the end of the file and
save it.

```
config.transitions = false
```

### Hide files from the file list

If you would like to hide files or whole folder from the left side bar list,
open your configuration by clicking at the cog icon at the toolbar 
(bottom left sixth icon) and add the followline at the end of the file and
save it. This hides all the files that start with a dot, and all the `.info`
files.

```
config.ignore_files = {"^%.", "%.info$"}
```

You can add as many rules as you want in there, to hide fore files or 
folders, as you like.


## Know issues
You can find the known issues at 
https://git.walkero.gr/walkero/lite-xl/issues


# Changelog

## [2.0.3.1] - 2022-01-18
### Changed
- Applied all the necessary changes to make it run under AmigaOS 4.1 FE