arthur/beluga
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Update Home

arthur
2025-10-28 09:10:09 +01:00
parent 73fa5e7555
commit 4f1a25869a
1 changed files with 74 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Home.md
+74 -55
@@ -1,55 +1,74 @@
# Beluga Wiki # Beluga Wiki
# Presentation # Presentation
Beluga is an open source text editor with lisp configuration files. Beluga is an open source text editor with lisp configuration files.
Several builtins functions are available, but you can create yours with lisp syntax. Several builtins functions are available, but you can create yours with lisp syntax.
# Functions # Installation
## From source
Here is a list of none exhaustive builtins functions. ### Requirements
## Map-key The project is build with meson so you will need it on your computer to compile the project. You will also need a C compiler.
### Syntax ### Process
``` lisp First clone the repo and move into it.
(map-key "key-binds" command) Then compile the project in the desire dir (for me build).
``` ````meson setup --reconfigure build
meson compile -C build````
### Description
The binary will be `build/beluga`.
The `map-key` function allows you to link lisp function (or builtins CLispFunction) to key sequences.
## From release
## Define
You have on the release page the binary of the editor already compile and ready to use on your computer. Just download it as artifact.
### Syntax
``` lisp # Functions
(define macro value)
``` Here is a list of none exhaustive builtins functions.
or
``` lisp ## Map-key
(define function-name (lisp-code)
``` ### Syntax
### Description ``` lisp
(map-key "key-binds" command)
The `define` function defines macros and functions that you will reuse in your code. ```
# Key-binds ### Description
Key-binds are defines with macro on key names. The `map-key` function allows you to link lisp function (or builtins CLispFunction) to key sequences.
| key-name | macro | ## Define
|-------------|-------------|
| arrow right | ARROW-RIGHT | ### Syntax
| arrow left | ARROW-LEFT | ``` lisp
| arrow up | ARROW-UP | (define macro value)
| arrow down | ARROW-DOWN | ```
| enter | ENTER | or
| backspace | BACKSPACE | ``` lisp
| delete | DEL | (define function-name (lisp-code)
| page up | PAGE-UP | ```
| page down | PAGE-DOWN |
| control | CTRL-letter | ### Description
The `define` function defines macros and functions that you will reuse in your code.
# Key-binds
Key-binds are defines with macro on key names.
| key-name | macro |
|-------------|-------------|
| arrow right | ARROW-RIGHT |
| arrow left | ARROW-LEFT |
| arrow up | ARROW-UP |
| arrow down | ARROW-DOWN |
| enter | ENTER |
| backspace | BACKSPACE |
| delete | DEL |
| page up | PAGE-UP |
| page down | PAGE-DOWN |
| control | CTRL-letter |