Update Home

2025-10-28 09:10:09 +01:00
parent 73fa5e7555
commit 4f1a25869a
1 changed files with 74 additions and 55 deletions
@@ -1,55 +1,74 @@
-# Beluga Wiki
-
-# Presentation
-
-Beluga is an open source text editor with lisp configuration files.
-Several builtins functions are available, but you can create yours with lisp syntax.
-
-# Functions
-
-Here is a list of none exhaustive builtins functions.
-
-## Map-key
-
-### Syntax
-
-``` lisp
-(map-key "key-binds" command)
-```
-
-### Description
-
-The `map-key` function allows you to link lisp function (or builtins CLispFunction) to key sequences.
-
-## Define
-
-### Syntax
-``` lisp
-(define macro value)
-```
-or
-``` lisp
-(define function-name (lisp-code)
-```
-
-### 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 |
-
+# Beluga Wiki
+
+# Presentation
+
+Beluga is an open source text editor with lisp configuration files.
+Several builtins functions are available, but you can create yours with lisp syntax.
+
+# Installation
+## From source
+### Requirements
+
+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.
+
+### Process
+ 
+First clone the repo and move into it. 
+Then compile the project in the desire dir (for me build).
+````meson setup --reconfigure build
+meson compile -C build````
+
+The binary will be `build/beluga`.
+
+## From release
+
+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. 
+
+# Functions
+
+Here is a list of none exhaustive builtins functions.
+
+## Map-key
+
+### Syntax
+
+``` lisp
+(map-key "key-binds" command)
+```
+
+### Description
+
+The `map-key` function allows you to link lisp function (or builtins CLispFunction) to key sequences.
+
+## Define
+
+### Syntax
+``` lisp
+(define macro value)
+```
+or
+``` lisp
+(define function-name (lisp-code)
+```
+
+### 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 |
+