From 243c49234ff94a5c5250bf9ef0b11cc0b7d0eb16 Mon Sep 17 00:00:00 2001 From: Robert Bendun Date: Sat, 14 Jan 2023 23:11:32 +0100 Subject: [PATCH] changed readme from pl to en --- CHANGELOG.md | 4 ++++ README.md | 54 ++++++---------------------------------------------- 2 files changed, 10 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bfab60..0e9f4dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Connection with MIDI ports via parameters dropped in favour of function using context system: `port` - Listing ports via REPL command: `:ports` instead of commandline parameter +### Changed + +- Readme from Polish to English + ### Removed - Release builder, since it's separate part of the project diff --git a/README.md b/README.md index 6497a39..fbf86cf 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,20 @@ # Musique interpreter -Interpreter języka Musique. Możliwy do wykorzystywania jako: +## Building -- biblioteka interpretera języka dołączana do innego projektu (podobnie jak Lua); -- REPL działający w systemie GNU/Linux + ALSA wykonujący język Musique. +Reference [`build_instructions.md`](./build_instructions.md). -## Wymagane pakiety systemowe - -Do poprawnego skompilowania i uruchomienia interpretera języka Musique należy posiadać zainstalowane następujące pakiety (lub ich odpowiedniki) – dla systemu GNU/Linux Ubuntu Desktop 22.04 są to: - -- `build-essential` – pakiet zawierający podstawowe narzędzia do pracy z kodem źródłowym, takie jak m.in. kompilator; -- `libasound2-dev` – pakiet zawierający biblioteki programistyczne pakietu `libasound2`. - -Można je zainstalować korzystając z polecenia: - -``` -$ sudo apt update -$ sudo apt install -y build-essential libasound2-dev -``` - -## Budowanie interpretera - -- Aby wybudować wersję Linux+ALSA: `make` -- Aby wybudować wersję Windows: `make os=windows` - -Żeby zainstalować interpreter języka Musique w systemie, należy dodatkowo wykonać polecenie: - -``` -# make install -``` - -*Uwaga*: powyższe polecenie instalacyjne musi zostać wykonane jako uprzywilejowany użytkownik (np. wykorzystując polecenie `sudo`). - -## Dostępne komendy - -- `make` - Buduje interpreter `bin/musique` (tryb release) -- `make debug` - Buduje interpreter `bin/debug/musique` (tryb debug) -- `make clean` - Usuwa reprodukowalne elementy projektu (automatycznie stworzone pliki binarne czy raporty) - -### Dokumentacja - -- `make doc` - Tworzy `doc/build/html/` zawierający dokumentację projektu - -### Testowanie - -- `make test` - Uruchom wszystkie dostępne testy automatyczne - -## Kolorowanie składni +## Syntax highlighting ### Vim / Neovim -Skopiuj plik [etc/editor/musique.vim](etc/editor/musique.vim) do folderu `syntax` wewnątrz twojej konfiguracji Vima (Neovima). Np: +Copy [editor/musique.vim](editor/musique.vim) to `syntax` directory inside your Vim (Neovim) configuration. ```console $ cp editor/musique.vim ~/.config/nvim/syntax/ ``` -Następnie musisz dodać ustawienie typu pliku na podstawie rozszerzenia wewnątrz twojej konfiguracji: +Next, you can add bindings for filetype: ```vim au BufRead,BufNewFile *.mq set filetype=musique @@ -64,7 +22,7 @@ au BufRead,BufNewFile *.mq set filetype=musique ### Visual Studio Code -Skopiuj katalog [editor/vscode-musique](editor/vscode-musique) do folderu `/.vscode/extensions` i uruchom ponownie program VSCode. +Copy [editor/vscode-musique](editor/vscode-musique) directory to `/.vscode/extensions` and restart VS Code. # Thanks to