Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 1.76 KB

README.md

File metadata and controls

54 lines (43 loc) · 1.76 KB
Raw
neosh

Neosh

Next-gen shell built with Rust and Lua.

Status License Discord Minimal Rustc version

Planned features

  • Customizable TUI
  • Configuration powered by LuaJIT
  • Well-documented API
  • Plugins
  • Doc system powered by neorg
  • Crossplatform
  • Instant config reload
  • Instant reload of paradigms (profiles)
  • Configurable log system

Requirements

  • rustc version: 1.59+

Installation

$ git clone https://github.com/neo-sh/neosh.git
$ cd neosh
$ cargo build --profile optimized

Contribution

Ideas for contributing

Rules for contributing

  1. One PR - one feature (refactoring codebase and bugfixes can be done in a single PR)
  2. Conventional commit names
  3. One change - one commit (for example, formatting whole code should be done in separated commit)

How to contribute

  1. Fork repository
  2. Create an issue about your contribution if does not exist
  3. Create draft PR
  4. Start coding

Credits

Logo made by Binx