changed readme from pl to en

This commit is contained in:
Robert Bendun 2023-01-14 23:11:32 +01:00
parent 588e15a8b6
commit 243c49234f
2 changed files with 10 additions and 48 deletions

View File

@ -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` - 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 - Listing ports via REPL command: `:ports` instead of commandline parameter
### Changed
- Readme from Polish to English
### Removed ### Removed
- Release builder, since it's separate part of the project - Release builder, since it's separate part of the project

View File

@ -1,62 +1,20 @@
# Musique interpreter # Musique interpreter
Interpreter języka Musique. Możliwy do wykorzystywania jako: ## Building
- biblioteka interpretera języka dołączana do innego projektu (podobnie jak Lua); Reference [`build_instructions.md`](./build_instructions.md).
- REPL działający w systemie GNU/Linux + ALSA wykonujący język Musique.
## Wymagane pakiety systemowe ## Syntax highlighting
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
### Vim / Neovim ### 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 ```console
$ cp editor/musique.vim ~/.config/nvim/syntax/ $ 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 ```vim
au BufRead,BufNewFile *.mq set filetype=musique au BufRead,BufNewFile *.mq set filetype=musique
@ -64,7 +22,7 @@ au BufRead,BufNewFile *.mq set filetype=musique
### Visual Studio Code ### Visual Studio Code
Skopiuj katalog [editor/vscode-musique](editor/vscode-musique) do folderu `<user home>/.vscode/extensions` i uruchom ponownie program VSCode. Copy [editor/vscode-musique](editor/vscode-musique) directory to `<user home>/.vscode/extensions` and restart VS Code.
# Thanks to # Thanks to