Skip to content

Commit

Permalink
Replaced linenoise lib with linenoise-mob
Browse files Browse the repository at this point in the history
Replaced the UI library with a more maintained version.
The new library fixed this issue: antirez/linenoise#158
  • Loading branch information
mckenney5 committed Aug 7, 2018
1 parent 9aa3275 commit 790cb74
Show file tree
Hide file tree
Showing 5 changed files with 375 additions and 137 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ qsh — _A small, lightweight, command interpreter_

## Description
This is the rewrite of quick terminal, quick terminal server edition, and QTerminal.
Quick shell aims at replacing bash or zsh with a smaller and lighter program and follows
Quick Shell aims at replacing `bash` or `zsh` with a smaller and lighter program and follows
the [suckless philosophy](https://suckless.org/philosophy/). (note this project is not
associated with suckless).

## License
This code (see exception) is licensed under the MIT license. See 'LICENSE' for details.

Note, the source code for [linenoise](https://github.com/antirez/linenoise) is also included in this repo which is under the BSD 2-Clause "Simplified" License. See [src/libs/LICENSE](https://raw.githubusercontent.com/mckenney5/qsh/master/src/libs/LICENSE) for more details.
Note, the source code for [linenoise-mob](https://github.com/rain-1/linenoise-mob) is also included in this repo which is under the BSD 2-Clause "Simplified" License. See [src/libs/LICENSE](https://raw.githubusercontent.com/mckenney5/qsh/master/src/libs/LICENSE) for more details.

## Compiling and Testing
This program allows a couple of compiling options.
Expand All @@ -24,7 +24,7 @@ The simplest way is to compile by `make`
* `make GNU` : makes the user interface use [GNU readline](https://tiswww.case.edu/php/chet/readline/rltop.html)
* `make TINY` : makes the UI only use fgets (aka no line editing, like sh(1))
* `make DEBUG` : adds debugging symbols to the program, along with verbose output
* `make` : makes the UI use the [linenoise libray](https://github.com/antirez/linenoise)
* `make` : makes the UI use the [linenoise-mob libray](https://github.com/rain-1/linenoise-mob)

##### (optional) Colors:
* NO_COLOR (`-DNO_COLOR`) : disables color in the prompt **ONLY**
Expand All @@ -41,3 +41,4 @@ Then:
6. After all of that **_then_** submit a merge/pull request

Any questions, feel free to email me at mckenneyadam [at] gmail

4 changes: 2 additions & 2 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
In order of importance

## General:
- [X] add info for GNU readline and author info on linenoise in README
- [X] add info for GNU readline and author info on linenoise-mob in README
- [ ] be usable as a default shell
- [ ] document and fix known bugs
- [X] add to github account
Expand All @@ -24,7 +24,7 @@ In order of importance
- [ ] test other libc implementations (musl, uClibc, etc)
- [ ] test in cygin
- [ ] write a manpage
- [ ] fix [this bug](https://github.com/antirez/linenoise/issues/158) in linenoise lib
- [X] fix [this bug](https://github.com/antirez/linenoise/issues/158) in linenoise lib

## Features:
- [X] basic features (ex run a command, change directories)
Expand Down
Loading

0 comments on commit 790cb74

Please sign in to comment.