From 3fb3067b6fbfeb93f0764128415fbf323da258e2 Mon Sep 17 00:00:00 2001 From: Vladislav Doster Date: Fri, 14 Apr 2023 17:11:08 -0500 Subject: [PATCH] feat: add lint gh action workflow --- .github/workflows/lint.yml | 15 ++++++++++++ README.md | 50 ++++++++++++++++++++------------------ 2 files changed, 42 insertions(+), 23 deletions(-) create mode 100644 .github/workflows/lint.yml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..b883403 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,15 @@ +name: Lint + +on: + pull_request: + branches: [main, master] + push: + branches: [main, master] + tags: ["v*.*.*"] + workflow_dispatch: + +jobs: + commit: + uses: zdharma-continuum/.github/.github/workflows/commit-job.yml@main + lint: + uses: zdharma-continuum/.github/.github/workflows/lint-job.yml@main diff --git a/README.md b/README.md index 2a6ea47..a894fda 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,19 @@ ![Dharma logos](https://raw.githubusercontent.com/wiki/zdharma-continuum/zui/img/logo_theme-fs8.png) -This is a RAD (Rapid Application Development) textual user interface library for Zsh. It in many aspects resembles typical CGI+(D)HTML setup. There are: +This is a RAD (Rapid Application Development) textual user interface library for Zsh. It in many aspects resembles +typical CGI+(D)HTML setup. There are: -* generators ran on "server" side (basic Zshell-code that is just generating text!), -* event loop that turns the generated text into document with active elements (buttons, anchors, toggle buttons, text fields, list boxes), -* mechanism to regenerate document parts from the original generators. +- generators ran on "server" side (basic Zshell-code that is just generating text!), +- event loop that turns the generated text into document with active elements (buttons, anchors, toggle buttons, text + fields, list boxes), +- mechanism to regenerate document parts from the original generators. -So, a Zshell code generates text. It is then turned into document with hyperlinks. DHTML-like calls are possible that will regenerate document parts on the fly. Page can be also reloaded with input data, just like an HTML page. +So, a Zshell code generates text. It is then turned into document with hyperlinks. DHTML-like calls are possible that +will regenerate document parts on the fly. Page can be also reloaded with input data, just like an HTML page. -A voiced [video tutorial](https://youtu.be/TfZ8b_RS_Bg) shows how to create an application – Nmap network scanner frontend. +A voiced [video tutorial](https://youtu.be/TfZ8b_RS_Bg) shows how to create an application – Nmap network scanner +frontend. ## Hello World @@ -50,15 +54,17 @@ zui-event-loop 1:demo_generator_A ![Hello World screenshot](https://raw.githubusercontent.com/wiki/zdharma-continuum/zui/img/hello-world-fs8.png) -Other example which uses list-box: [zui-demo-list-box](https://github.com/zdharma-continuum/zui/blob/master/demos/zui-demo-list-boxes) +Other example which uses list-box: +[zui-demo-list-box](https://github.com/zdharma-continuum/zui/blob/master/demos/zui-demo-list-boxes) -The API is described at the [wiki](https://github.com/zdharma-continuum/zui/wiki). Checkout [screenshots](https://github.com/zdharma-continuum/zui/wiki/Screenshots) -and [Asciinema recordings](https://github.com/zdharma-continuum/zui/wiki/Asciinema). +The API is described at the [wiki](https://github.com/zdharma-continuum/zui/wiki). Checkout +[screenshots](https://github.com/zdharma-continuum/zui/wiki/Screenshots) and +[Asciinema recordings](https://github.com/zdharma-continuum/zui/wiki/Asciinema). ## Installation -**The plugin is "standalone"**, which means that only sourcing it is needed. So to -install, unpack `zui` somewhere and add +**The plugin is "standalone"**, which means that only sourcing it is needed. So to install, unpack `zui` somewhere and +add ```zsh source {where-zui-is}/zui.plugin.zsh @@ -66,28 +72,26 @@ source {where-zui-is}/zui.plugin.zsh to `zshrc`. -If using a plugin manager, then `Zinit` is recommended, but you can use any -other too, and also install with `Oh My Zsh` (by copying directory to -`~/.oh-my-zsh/custom/plugins`). +If using a plugin manager, then `Zinit` is recommended, but you can use any other too, and also install with `Oh My Zsh` +(by copying directory to `~/.oh-my-zsh/custom/plugins`). ### Zinit -Add `zinit load zdharma-continuum/zui` to your `.zshrc` file. Zinit will handle -cloning the plugin for you automatically the next time you start zsh. To update -(i.e. to pull from origin) issue `zinit update zdharma-continuum/zui`. +Add `zinit load zdharma-continuum/zui` to your `.zshrc` file. Zinit will handle cloning the plugin for you automatically +the next time you start zsh. To update (i.e. to pull from origin) issue `zinit update zdharma-continuum/zui`. ### Antigen -Add `antigen bundle zdharma-continuum/zui` to your `.zshrc` file. Antigen will handle -cloning the plugin for you automatically the next time you start zsh. +Add `antigen bundle zdharma-continuum/zui` to your `.zshrc` file. Antigen will handle cloning the plugin for you +automatically the next time you start zsh. ### Oh-My-Zsh 1. `cd ~/.oh-my-zsh/custom/plugins` -2. `git clone git@github.com:zdharma-continuum/zui.git` -3. Add `zui` to your plugin list +1. `git clone git@github.com:zdharma-continuum/zui.git` +1. Add `zui` to your plugin list ### Zgen -Add `zgen load zdharma-continuum/zui` to your .zshrc file in the same place you're doing -your other `zgen load` calls in. +Add `zgen load zdharma-continuum/zui` to your .zshrc file in the same place you're doing your other `zgen load` calls +in.