diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 73 |
1 files changed, 7 insertions, 66 deletions
@@ -1,39 +1,6 @@ -# Vimb - the Vim-like browser +# neovimb -[![Build Status](https://travis-ci.com/fanglingsu/vimb.svg?branch=master)](https://travis-ci.com/fanglingsu/vimb) -[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -[![Latest Release](https://img.shields.io/github/release/fanglingsu/vimb.svg?style=flat)](https://github.com/fanglingsu/vimb/releases/latest) - -Vimb is a Vim-like web browser that is inspired by Pentadactyl and Vimprobable. -The goal of Vimb is to build a completely keyboard-driven, efficient and -pleasurable browsing-experience with low memory and CPU usage that is -intuitive to use for Vim users. - -More information and some screenshots of Vimb browser in action can be found on -the project page of [Vimb][]. - -## Features - -- it's modal like Vim -- Vim like keybindings - assignable for each browser mode -- nearly every configuration can be changed at runtime with Vim like set syntax -- history for `ex` commands, search queries, URLs -- completions for: commands, URLs, bookmarked URLs, variable names of settings, search-queries -- hinting - marks links, form fields and other clickable elements to - be clicked, opened or inspected -- SSL validation against ca-certificate file -- user defined URL-shortcuts with placeholders -- read it later queue to collect URIs for later use -- multiple yank/paste registers -- Vim like autocmd - execute commands automatically after an event on specific URIs - -## Packages - -- Arch Linux: [community/vimb][], [aur/vimb-git][], [aur/vimb-gtk2][] -- Gentoo: [gentoo-git][], [gentoo][] -- openSUSE: [network/vimb][] -- pkgsrc: [pkgsrc/www/vimb][], [pkgsrc/wip/vimb-git][] -- Slackware: [slackbuild/vimb][] +neovimb is a fork of [vimb](https://github.com/fanglingsu/vimb) but with a couple different tweaks like default settings oriented torwards privacy and a bit more config.h customizability. ## dependencies @@ -43,8 +10,8 @@ the project page of [Vimb][]. ## Install -Edit `config.mk` to match your local setup. You might need to do this if -you use another compiler, like tcc. Most people, however, will almost never +Edit `config.mk` to match your local setup. You might need to do this if +you use another compiler, like tcc. Most people, however, will almost never need to do this on systems like Ubuntu or Debian. Edit `src/config.h` to match your personal preferences, like changing the @@ -56,47 +23,21 @@ Therefore, you should always compare your customised `config.h` with `config.def.h` and make sure you include any changes to the latter in your `config.h`. -Run the following commands to compile and install Vimb (if necessary, the last one as +Run the following commands to compile and install neovimb (if necessary, the last one as root). If you want to change the `PREFIX`, note that it's required to give it on both stages, build and install. make PREFIX=/usr make PREFIX=/usr install -To run vimb without installation for testing it out use the 'runsandbox' make +To run neovimb without installation for testing it out use the 'runsandbox' make target. make runsandbox -## Mailing list - -- feature requests, issues and patches can be discussed on the [mailing list][mail] ([list archive][mail-archive]) - ## Similar projects -- [luakit](https://luakit.github.io/) -- [qutebrowser](https://www.qutebrowser.org/) -- [surf](https://surf.suckless.org/) -- [uzbl](https://www.uzbl.org/) +- [vimb](https://github.com/fanglingsu/vimb) ## license Information about the license are found in the file LICENSE. - -## about - -- https://en.wikipedia.org/wiki/Vimb -- http://thedarnedestthing.com/vimb -- https://blog.jeaye.com/2015/08/23/vimb/ - -[aur/vimb-git]: https://aur.archlinux.org/packages/vimb-git -[aur/vimb-gtk2]: https://aur.archlinux.org/packages/vimb-gtk2/ -[community/vimb]: https://www.archlinux.org/packages/community/x86_64/vimb/ -[gentoo-git]: https://github.com/tharvik/overlay/tree/master/www-client/vimb -[gentoo]: https://github.com/hsoft/portage-overlay/tree/master/www-client/vimb -[mail-archive]: https://sourceforge.net/p/vimb/vimb/vimb-users/ "vimb - mailing list archive" -[mail]: https://lists.sourceforge.net/lists/listinfo/vimb-users "vimb - mailing list" -[network/vimb]: https://build.opensuse.org/package/show/network/vimb -[pkgsrc/wip/vimb-git]: http://pkgsrc.se/wip/vimb-git -[pkgsrc/www/vimb]: http://pkgsrc.se/www/vimb -[slackbuild/vimb]: https://slackbuilds.org/repository/14.2/network/vimb/ -[vimb]: https://fanglingsu.github.io/vimb/ "Vimb - Vim like browser project page" |