From 065114644cefc5275810482e33d20325d70c11e0 Mon Sep 17 00:00:00 2001 From: George Sokianos Date: Fri, 17 Jan 2025 20:09:59 +0000 Subject: [PATCH] Syntax fixes --- README_Amiga.md | 54 ++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README_Amiga.md b/README_Amiga.md index a832884a..7f77197f 100644 --- a/README_Amiga.md +++ b/README_Amiga.md @@ -2,8 +2,8 @@ Lite XL is a lightweight text editor written in Lua and SDL2. -The port is not perfect and it might have issues here and there. It might -crash from time to time, if there is a path problem, but overall it works +The port is not perfect, and it might have issues here and there. 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. @@ -13,9 +13,9 @@ 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 installation +well, as plugins, themes etc... By default, this version uses the installation folder, but if you want to override it, you can create an ENV variable -named `HOME` and set there your prefferable path. +named `HOME` and set there your preferable path. You can check if there is one already set by executing the following command in a shell @@ -25,36 +25,36 @@ 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. +Change the path to 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 +Colours are lua files that set the colour 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 +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 +at the cog icon on the toolbar (bottom left sixth icon). Go to the line that looks like below ``` -- core.reload_module("colors.summer") ``` -and change the `summer` with the name of your color theme. Also, remove +and change the `summer` with the name of your colour 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. +did everything right, the colour schema should change instantly. The themes can also be found at https://github.com/lite-xl/lite-xl-colors ### Plugins -LiteXL is able to use plugins to extend its features. Those can be found +LiteXL can use plugins to extend its features. Those can be found at https://github.com/lite-xl/lite-xl-plugins and other websites. Not all of them will work fine on AmigaOS 4 or MorphOS, because of missing dependencies or filesystem issues. @@ -64,7 +64,7 @@ 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 +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. @@ -72,7 +72,7 @@ The included plugins are the following: **amimodkeys** This plugin enables the Right Amiga and Right Alt to behave like Control, -for those that are used to use them. +for those that are used to using them. **autoinsert** Automatically inserts closing brackets and quotes. Also allows selected @@ -93,10 +93,10 @@ Underlines matching pair for bracket under the caret **codesets** This plugin uses the codesets.library on AmigaOS 4 and the -charsets.library on MorphOS to translate ISO encoded files to unicode -and vice-versa. When this is enabled new menu items are added to -load/save the code with a different encoding. Also there is a new -section at the status bar that show the file encoding. +charsets.library on MorphOS to translate ISO encoded files to Unicode +and vice versa. When this is enabled, new menu items are added to +load/save the code with a different encoding. Also, there is a new +section at the status bar that shows the file encoding. This plugin is **EXPERIMENTAL** and heavily inspired from the encoding plugin at https://github.com/jgmdev/lite-xl-encoding @@ -105,9 +105,9 @@ Underlays color values (eg. `#ff00ff` or `rgb(255, 0, 255)`) with their resultant color. **custom_caret** -Customize the caret in the editor setting it to *underline*, *block* or -*line* at the init.lua file in your config folder. -For example add: +Customize the caret in the editor, setting it to *underline*, *block* or +*line* in the init.lua file in your config folder. +For example, add: `config.plugins.custom_caret.shape = "block"` **EditorConfig** @@ -115,13 +115,13 @@ EditorConfig (https://editorconfig.org/) implementation for Lite XL **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. +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. On AmigaOS 4 it uses *urlopen* and on MorphOS it uses *openurl* to load -the generated html in the browser. It requires a GitHub application token -because it uses its Rest API. Add it at the init.lua file in your config +the generated HTML in the browser. It requires a GitHub application token +because it uses its Rest API. Add it to the init.lua file in your config folder like below: `config.plugins.ghmarkdown.github_token = ""` @@ -186,7 +186,7 @@ Select a color theme, like VScode, Sublime Text. Highlights regions of code that match the current selection **smallclock** -It adds a small clock at the bottom right corner. +It adds a small clock in the bottom-right corner. **sort** Sorts selected lines alphabetically @@ -218,7 +218,7 @@ 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, +If you would like to hide files or whole folder from the left sidebar 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` @@ -240,11 +240,11 @@ folders, as you like. 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 +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: +please consider buying me a coffee at: https://ko-fi.com/walkero ## Known issues