diff options
| author | John Bampton <[email protected]> | 2021-04-11 12:51:28 +1000 |
|---|---|---|
| committer | Yukihiro "Matz" Matsumoto <[email protected]> | 2021-04-16 16:37:52 +0900 |
| commit | 9d32d440ebf1ebd0684f5349316a15602bea5421 (patch) | |
| tree | ae119a76ef9922d77fd9d13efc095e0a746253ec /README.md | |
| parent | ac9038121bec0141b93c8751248ffdb7688b9474 (diff) | |
| download | mruby-9d32d440ebf1ebd0684f5349316a15602bea5421.tar.gz mruby-9d32d440ebf1ebd0684f5349316a15602bea5421.zip | |
feat(CI): add the GitHub Super Linter
The GitHub Super Linter is a more robust and better supported
tool than the current GitHub Actions we are using.
Running these checks:
ERROR_ON_MISSING_EXEC_BIT: true
VALIDATE_BASH: true
VALIDATE_BASH_EXEC: true
VALIDATE_EDITORCONFIG: true
VALIDATE_MARKDOWN: true
VALIDATE_SHELL_SHFMT: true
VALIDATE_YAML: true
https://github.com/marketplace/actions/super-linter
https://github.com/github/super-linter
Added the GitHub Super Linter badge to the README.
Also updated the pre-commit framework and added
more documentation on pre-commit.
Added one more pre-commit check: check-executables-have-shebangs
Added one extra check for merge conflicts to our
GitHub Actions.
EditorConfig and Markdown linting.
Minor grammar and spelling fixes.
Update linter.yml
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 14 insertions, 5 deletions
@@ -1,4 +1,7 @@ +# mruby + [![Build Status][build-status-img]][travis-ci] +[](https://github.com/marketplace/actions/super-linter) ## What is mruby @@ -24,13 +27,15 @@ The latest development version of mruby can be downloaded via the following URL: The trunk of the mruby source tree can be checked out with the following command: - $ git clone https://github.com/mruby/mruby.git +``` +$ git clone https://github.com/mruby/mruby.git +``` You can also install and compile mruby using [ruby-install](https://github.com/postmodern/ruby-install), [ruby-build](https://github.com/rbenv/ruby-build) or [rvm](https://github.com/rvm/rvm). ## mruby home-page -The URL of the mruby home-page is: https://mruby.org. +The URL of the mruby home-page is: <https://mruby.org>. ## Mailing list @@ -46,12 +51,16 @@ There are two sets of documentation in mruby: the mruby API (generated by yard) To build both of them, simply go - rake doc +``` +rake doc +``` You can also view them in your browser - rake view_api - rake view_capi +``` +rake view_api +rake view_capi +``` ## How to customize mruby (mrbgems) |