HigherOrderCO/Kind
1
1
Fork 0
mirror of https://github.com/HigherOrderCO/Kind.git synced 2024-07-14 22:40:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

add usage notes

Browse Source
This commit is contained in:
Victor Taelin 2024-02-08 20:04:56 -03:00
parent c4c909994d
commit 9c5ecdeb16
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,4 +5,17 @@ Kind1 has been developed in JavaScript, which wasn't meant to be a long-term
solution, but allowed us to explore self-types. Recently, we started developing
Kind2 for [HVM1](https://github.com/HigherOrderCO/HVM1), but it has been
discontinued when we started working on HVM2. In this repository, we'll remake
and continue Kind2's development, now targetting HVM2.
and continue Kind2's development, now targetting HVM2. Kind2 will be fully
implemented in itself. Temporarily, we're using `TypeScript+HVM1` to aid on the
bootstrapping process.
Usage
=====
1. Install [NPM](https://www.npmjs.com/).
2. Install [HVM1](https://github.com/HigherOrderCO/HVM1).
3. Install Kind2: `npm i -g` (from this directory)
4. Enter `book/` and run with `kind2 [check|run] term_name`.