Update readme and changelog for release 1.14
This commit is contained in:
parent
3a38ded396
commit
e50d67df85
37
changelog.md
37
changelog.md
|
@ -2,6 +2,43 @@ Lite XL is following closely [rxi/lite](https://github.com/rxi/lite) but with so
|
||||||
|
|
||||||
This files document the differences between Lite XL and rxi/lite for each version.
|
This files document the differences between Lite XL and rxi/lite for each version.
|
||||||
|
|
||||||
|
### 1.14
|
||||||
|
|
||||||
|
**Project Management**
|
||||||
|
|
||||||
|
Add a new command, Core: Change Project Folder, to change project directory by staying on the same window.
|
||||||
|
All the current opened documents will be closed.
|
||||||
|
The new command is associated with the keyboard combination ctrl+shit+c.
|
||||||
|
|
||||||
|
A similar command is also added, Core: Open Project Folder, with key binding ctrl+shift+o.
|
||||||
|
It will open the chosen folder in a new window.
|
||||||
|
|
||||||
|
In addition Lite XL will now remember the recently used projects across different sessions.
|
||||||
|
When invoked without arguments it will now open the project more recently used.
|
||||||
|
If a directory is specified it will behave like before and open the directory indicated as an argument.
|
||||||
|
|
||||||
|
**Restart command**
|
||||||
|
|
||||||
|
A Core: Restart command is added to restart the editor without leaving the current window.
|
||||||
|
Very convenient when modifying the Lua code for the editor itself.
|
||||||
|
|
||||||
|
**User's setting auto-reload**
|
||||||
|
|
||||||
|
When saving the user configuration, the user's module, the changes will be automatically applied to the
|
||||||
|
current instance.
|
||||||
|
|
||||||
|
**Bundle community provided colors schemes**
|
||||||
|
|
||||||
|
Included now in the release files the colors schemes from github.com/rxi/lite-colors.
|
||||||
|
|
||||||
|
**Usability improvements**
|
||||||
|
|
||||||
|
Improve left and right scrolling of text to behave like other editors and improves text selection with mouse.
|
||||||
|
|
||||||
|
**Fixes**
|
||||||
|
|
||||||
|
Correct font's rendering for full hinting mode when using subpixel antialiasing.
|
||||||
|
|
||||||
### 1.13
|
### 1.13
|
||||||
|
|
||||||
**Rendering options for fonts**
|
**Rendering options for fonts**
|
||||||
|
|
35
doc/usage.md
35
doc/usage.md
|
@ -3,22 +3,31 @@
|
||||||
![screenshot](https://user-images.githubusercontent.com/3920290/81471642-6c165880-91ea-11ea-8cd1-fae7ae8f0bc4.png)
|
![screenshot](https://user-images.githubusercontent.com/3920290/81471642-6c165880-91ea-11ea-8cd1-fae7ae8f0bc4.png)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
lite is a lightweight text editor written mostly in Lua — it aims to provide
|
Lite is a lightweight text editor written mostly in Lua — it aims to provide
|
||||||
something practical, pretty, *small* and fast, implemented as simply as
|
something practical, pretty, *small* and fast, implemented as simply as
|
||||||
possible; easy to modify and extend, or to use without doing either.
|
possible; easy to modify and extend, or to use without doing either.
|
||||||
|
|
||||||
|
Lite XL is based on the Lite editor itself and provide some enhancements
|
||||||
|
while remaining perfectly compatible with Lite.
|
||||||
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
When lite is started it's typically opened with a *project directory* — this
|
Lite works using a *project directory* — this is the directory where your
|
||||||
is the directory where your project's code and other data resides. The project
|
project's code and other data resides.
|
||||||
directory is set once when lite is started and, for the duration of the
|
|
||||||
session, cannot be changed.
|
|
||||||
|
|
||||||
To open lite with a specific project directory the directory name can be passed
|
To open lite with a specific project directory the directory name can be passed
|
||||||
as a command-line argument *(`.` can be passed to use the current directory)* or
|
as a command-line argument *(`.` can be passed to use the current directory)* or
|
||||||
the directory can be dragged onto either the lite executable or a running
|
the directory can be dragged onto either the lite executable or a running
|
||||||
instance of lite.
|
instance of lite.
|
||||||
|
|
||||||
|
Once started the project directory can be changed using the command
|
||||||
|
`core:change-project-folder`. The command will close all the documents
|
||||||
|
currently opened and switch to the new project directory.
|
||||||
|
|
||||||
|
If you want to open a project directory in a new window the command
|
||||||
|
`core:open-project-folder` will open a new editor window with the selected
|
||||||
|
project directory.
|
||||||
|
|
||||||
The main way of opening files in lite is through the `core:find-file` command
|
The main way of opening files in lite is through the `core:find-file` command
|
||||||
— this provides a fuzzy finder over all of the project's files and can be
|
— this provides a fuzzy finder over all of the project's files and can be
|
||||||
opened using the **`ctrl+p`** shortcut by default.
|
opened using the **`ctrl+p`** shortcut by default.
|
||||||
|
@ -42,7 +51,8 @@ have been loaded.
|
||||||
|
|
||||||
The user module can be modified by running the `core:open-user-module` command
|
The user module can be modified by running the `core:open-user-module` command
|
||||||
or otherwise directly opening the `$HOME/.config/lite-xl/init.lua` file.
|
or otherwise directly opening the `$HOME/.config/lite-xl/init.lua` file.
|
||||||
As an exception, on Windows, the variable `$USERPROFILE` will be used instead of
|
|
||||||
|
On Windows, the variable `$USERPROFILE` will be used instead of
|
||||||
`$HOME`.
|
`$HOME`.
|
||||||
|
|
||||||
Please note that Lite XL differs from the standard Lite editor for the location
|
Please note that Lite XL differs from the standard Lite editor for the location
|
||||||
|
@ -143,8 +153,8 @@ Plugins can be downloaded from the [plugins repository](https://github.com/rxi/l
|
||||||
## Restarting the editor
|
## Restarting the editor
|
||||||
|
|
||||||
If you modifies the user configuration file or some of the Lua implementation files you may
|
If you modifies the user configuration file or some of the Lua implementation files you may
|
||||||
restart the editor using the command "Core: Restart".
|
restart the editor using the command `core:restart`.
|
||||||
All the application will be restarting by keeping the window that is already used.
|
All the application will be restarting by keeping the window that is already in use.
|
||||||
|
|
||||||
|
|
||||||
## Color Themes
|
## Color Themes
|
||||||
|
@ -156,8 +166,13 @@ Additional color themes can be installed in the user's directory in a folder nam
|
||||||
|
|
||||||
A color theme can be set by requiring it in your user module:
|
A color theme can be set by requiring it in your user module:
|
||||||
```lua
|
```lua
|
||||||
require "colors.winter"
|
core.reload_module "colors.winter"
|
||||||
```
|
```
|
||||||
|
|
||||||
Color themes can be downloaded from the [color themes repository](https://github.com/rxi/lite-colors).
|
In the Lite editor the function `require` is used instead of `core.reload_module`.
|
||||||
|
In Lite XL `core.reload_module` should be used to ensure that the color module
|
||||||
|
is actually reloaded when saving the user's configuration file.
|
||||||
|
|
||||||
|
Color themes can be downloaded from the [color themes repository](https://github.com/rxi/lite-colors).
|
||||||
|
They are included with Lite XL release packages.
|
||||||
|
|
||||||
|
|
|
@ -103,7 +103,7 @@ init_lua:
|
||||||
}
|
}
|
||||||
lua_setglobal(L, "ARGS");
|
lua_setglobal(L, "ARGS");
|
||||||
|
|
||||||
lua_pushstring(L, "1.13");
|
lua_pushstring(L, "1.14");
|
||||||
lua_setglobal(L, "VERSION");
|
lua_setglobal(L, "VERSION");
|
||||||
|
|
||||||
lua_pushstring(L, SDL_GetPlatform());
|
lua_pushstring(L, SDL_GetPlatform());
|
||||||
|
|
Loading…
Reference in New Issue