lite-xl/README_Amiga.md

# Lite XL v2 for AmigaOS 4.1 FE & MorphOS 3

Lite XL is a lightweight text editor written in Lua.

The port is not perfect and it might have issues here and there. For example
the filesystem notifications are not working yet. So when you make changes
at a project folder those will not be reflected in Lite XL automatically.

It might crash from time to time, if there is a path problem, but overall
it works pretty well. This is my daily editor for any kind of development.
If it crashes on your system, try to delete to `.config` folder.

## New features against Lite XL v1
- Faster file scrolling
- Faster switch between tabs
- Reposition tabs at the side or at the bottom of other tabs, making
  multiple columns/rows of opened files
- Multiple cursor editing
- Better font manipulation and appearance
- Faster transitions

## 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 version uses the
executable folder, but if you want to overide it, you can create an ENV 
variable named `HOME` and set there your prefferable 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
This Lite XL release is based on version 2.0.3 of the application as 
released on other systems, by the original development team.
This not the latest version. This means that some of the latest 
plugins might not working at all or need modifications to work.

To make it easier for you, I gathered some of the plugins that are working
well, and I included them under `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.

Please, choose wisely, because adding all the plugins might make the editor
slower on your system. I would recommend you add only those that you really
need.

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

**minimap**
Shows a minimap on the right-hand side of the docview. Please note that 
this plugin will make the editor slower on file loading and scrolling.

**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

**smallclock**
It adds a small clock at the bottom right corner.

## Tips and tricks

### Transitions

If you want to disable the transitions and make the editor faster,
open your configuration file by clicking at the cog icon at the toolbar 
(bottom left, 6th icon) and add the following line at the end of the file,
and then save it. You might need to restart your editor (CTRL+SHIFT+R)

```
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. You might need to restart your editor (CTRL+SHIFT+R)

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

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

## I would like to thank

- IconDesigner for the proper glow icons that are included in the release
- Capehill for his tireless work on SDL port for AmigaOS 4.1 FE
- Michael Trebilcock for his port on liblua
- Bruno "BeWorld" Peloille for his great work on porting SDL to MorphOS
  and for his valuable help
- Lite XL original team for being helpful and providing info

Without all the above Lite XL would not be possible

## Support
If you enjoy what I am doing and would like to keep me up during the night,
please consider to buy me a coffee at:
https://ko-fi.com/walkero

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

# Changelog

## [2.0.3r3] - future
### Fixed
- Fixed non existing path crashes on OS4
- Fixed editor refresh whenever init.lua is changed, no matter the working 
  folder
- Fixed an issue when the user added a directory in the project that
  already existed

## [2.0.3r2] - 2022-06-18
### Added
- First public MorphOS version released

### Changed
- Merged source code for both AmigaOS 4 and MorphOS
- Moved the declaration of the $VER and $STACK for the AmigaOS 4 version,
  so to happen only once (reported by capehill)

### Fixed
- Fixed the usage of NumPad (reported by root)


## [2.0.3r1] - 2022-03-30
### Changed
- Applied all the necessary changes to make it run under AmigaOS 4.1 FE
- Fixes and changes

# Disclaimer
YOU MAY USE IT AT YOUR OWN RISK!
I will not be held responsible for any data loss or problems you might get
by using this software.