Browse Source

updates I guess

K. Lange 10 months ago
parent
commit
8e2c289b38
1 changed files with 25 additions and 3 deletions
  1. 25 3
      README.md

+ 25 - 3
README.md

@@ -10,9 +10,7 @@ Inspired by Vim (one might say a Bad Imitation) and featuring similar mode-based
 
 Bim is intended as the included text editor in ToaruOS, a hobby operating system built from scratch.
 
-Bim aims to be lightweight and featureful with no external dependencies, providing a modern editing experience in a lightweight, extensible package.
-
-_**NOTE:**_ This branch currently represents a preview of an in-progress rewrite of Bim currently dubbed "Bim 3", which is being rebuilt from the ground up around Kuroko to provide a fully integrated environment for writing plugins and extensions.
+Bim aims to be lightweight and featureful with no external* dependencies, providing a modern editing experience in a lightweight, extensible package.
 
 ## Features
 
@@ -46,6 +44,30 @@ Additionally, in this and future versions, a system installation of [Kuroko](htt
 
 Bim has been built successfully for a number of targets, including various BSDs, ToaruOS, Sortix, and others.
 
+### Installation
+
+First, install Kuroko:
+
+```bash
+git clone https://github.com/kuroko-lang/kuroko
+cd kuroko
+make && sudo make install # You can obtain deb packages, or build one with 'fpm' with 'make deb'
+```
+
+Then build Bim:
+
+```bash
+git clone https://github.com/klange/bim
+cd bim
+make && sudo make install
+```
+
+Then install the example config:
+
+```bash
+cp docs/example.bim3rc ~/.bim3rc
+```
+
 ### Terminal Support
 
 Bim has been tested in a number of terminals, and while it does not use `terminfo` databases, basic functionality should be available in the vast majority of remnant emulators and even classic DEC hardware.