diff --git a/.gitea/workflows/build.yml b/.gitea/workflows/build.yml index 8848291..521c389 100644 --- a/.gitea/workflows/build.yml +++ b/.gitea/workflows/build.yml @@ -6,7 +6,7 @@ on: jobs: build: - runs-on: home-1 + runs-on: ubuntu-latest steps: - name: Checkout code diff --git a/README.md b/README.md index 98382c1..8f72914 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,29 @@ # Beluga -Beluga is a project of CLI text editor that will fit perfectly with your azerty keyboard. +Beluga is a project of CLI text editor that uses lisp as configuration language. +It's abviously only working for **Linux**. ## Requirements -You will only need **cmake** and **clang** to compile the editor. +You will only need **meson** and a **C compiler** to compile the editor. ## Installation Here is the installation line for development version: -```git clone --recurse-submodules https://github.com/le-cocotier/beluga.git ~/.beluga && cd ~/.beluga && mkdir build && cd build && cmake ../ && make beluga``` +```git clone https://homelinuxserver.ddns.net/git/arthur/beluga.git ~/.beluga && cd ~/.beluga && meson setup --reconfigure build && meson compile -C build``` -The executable file will be in `bin/beluga`. Feel free to add it to your path. - -You can either run `make all` or `make doc_doxygen` if you're interested by the doxygen documentation. +The executable file will be `build/beluga`. Feel free to add it to your path. ## Getting start To open an existing file just type : -```beluga path_to_my_file``` +```./build/beluga path_to_my_file``` -The only keybinds that you will need will be : - - Ctrl-Q : leave the editor - - Ctrl-S : Save a file +Here is some few command that you will need : + +| keybind| command | +|--------|------------------| +| Ctrl-Q | leave the editor | +| Ctrl-S | Save a file | +| Ctrl-O | open file |