diff --git a/README.md b/README.md index 3fe8c4c..66f0d58 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ HCPL is a programming language and a proof checker based on illative combinatory logic - a foundational system dating back to the work of -Haskell Curry and his school. In one sentence, one could (somewhat -metaphorically) say that the logic is dynamically typed. As a -programming language, HCPL is similar to Lisp but with more syntactic -sugar. +Haskell Curry and his school. One could say that the logic is dynamically +typed. As a programming language, HCPL is similar to Lisp but with more +syntactic sugar. Features -======== +-------- * Functional language with pattern matching, macros, modules and custom syntax extensions. -* Relatively efficient interpreter, with unboxed values, etc. +* Relatively efficient interpreter with unboxed values. * Higher-order illative logic with basic support for inductive datatypes. * Rudimentary tactics and standard library. @@ -19,18 +18,14 @@ The current version is a prototype, but it is complete and stable enough to be usable. Requirements -============ +------------ * OCaml * dune * m4, sed, diff, GNU make -* Kate text editor - -The Kate text editor is not strictly necessary, but highly -recommended, because syntax highlighting is available and -automatically installed for it. +* Kate text editor (optional) Installation and usage -====================== +---------------------- To compile HCPL type: ``` @@ -59,20 +54,20 @@ options. To remove HCPL from your system type: `uninstall-hcpl` (note: this will remove the data directory completely). Examples -======== +-------- The [`examples/`](examples) subdirectory of the data directory contains commented examples which form a tutorial introduction to HCPL. Some knowledge of logic and functional programming is necessary to understand them. You should read the examples in their numerical -order. Preferably, *.hcpl files should be edited in Kate as syntax +order. Preferably, `*.hcpl` files should be edited in Kate as syntax highlighting is installed for this editor. In case the highlighting does not work, there are also html versions of the examples. Copyright and license -===================== +--------------------- -Copyright (C) 2013-2021 by Lukasz Czajka +Copyright (C) 2013-2021 by Lukasz Czajka. HCPL is distributed under the MIT license. See the [LICENSE](LICENSE) file.