midori

README

Contributing • Installation • Configuration • License • Submit an Issue

Installation

# Compile
go build -v -o midori ./cmd/midori/main.go
# Move
sudo mv midori /usr/bin/midori
# Add midori to shell list
sudo echo /usr/bin/midori >> /etc/shells
# Change shell
chsh -s /usr/bin/midori

Configuration

The configuration is done from the .midorirc file in the home directory. So how can you do?

# .midorirc has this text by default
echo -e "Welcome to \033[1;32mMidori v0.1\033[0m"
echo -e "Type \033[1;36mhelp\033[0m for guide"

# add your own configuration

# example:
alias ls=ls --color=always
# this alias makes your ls output colorful
export MIDORI_PROMPT=midori>
# you can also change the prompt
export MIDORI_HELPERS=0
# You turn off midori's features such as autocomplete, hint, etc. In this way, midori does not read all the executable files in the PATH variable and the files in the current folder.

Known Issues / TODO List

• Given an incorrect path to the cd command, it still changes PWD.
• Add current directory's files and directories to completion and hint handlers
• Improve completion handler and hint handler
• Make Midori fully-configurable
• Tip handler sometimes trims incorrectly

Contributing

All contributions to Midori are welcome, no matter how big. Before becoming a Contributor, please read the Contributing Guide.

License

Midori is licensed under the terms of MIT License.

Documentation

Index

• Constants

Constants

const Version = "v0.2.0"