From 70e82c40568607aaed5498c8293ef519e0469a1b Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" Date: Thu, 19 Sep 2024 21:09:34 -0700 Subject: [PATCH] 188 update readme (#212) * lint README * replace language extension --------- Co-authored-by: Dr. Ernie Prabhakar <19791+drernie@users.noreply.github.com> --- README.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f250b672..89e89431 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,48 @@ # Homiconic C -version: 0.5.11 -[![Codeship Status for TheSwanFactory/hclang](https://app.codeship.com/projects/b1198f30-aee9-0137-5fdc-4a1003a17a1c/status?branch=master)](https://app.codeship.com/projects/362584) +version: 0.5.14 ## Introduction -[Homoiconic C](https://theswanfactory.wordpress.com/2016/12/20/homoiconic-c-a-universal-language-for-code-and-data/) (HC) is a single universal language for code and data. This repository contains the first implementation of HC as an interpreter written in TypeScript running on `nodejs`. It also contains a sample application called MAML, the [*Multipurpose Abstract Markup Language*](https://theswanfactory.wordpress.com/2016/11/08/introducing-maml-a-draft-proposal-for-html6/). MAML is a radically simple proposal for replacing all the existing web technologies (HMTL, CSS, JavaScript, SVG, etc.) with a single format based on HC. It can also be used to define easily-parseable variants of other common file formats (e.g., HCSV, HCSON). +[Homoiconic C](https://theswanfactory.wordpress.com/2016/12/20/homoiconic-c-a-universal-language-for-code-and-data/) (HC) is a single universal language for code and data. This repository contains the first implementation of HC as an interpreter written in TypeScript running on `nodejs`. + +It also contains a sample application called MAML, the [*Multipurpose Abstract Markup Language*](https://theswanfactory.wordpress.com/2016/11/08/introducing-maml-a-draft-proposal-for-html6/). MAML is a radically simple proposal for replacing all the existing web technologies (HMTL, CSS, JavaScript, SVG, etc.) with a single format based on HC. + +HC can also be used to define easily-parseable variants of other common file formats (e.g., HCSV, HCSON). ## Usage +```shell +npm install +export DEBUG=true # optional +npm run hc ``` -$ npm install -$ export DEBUG=true # optional -$ npm run hc -``` + This will launch the interpreter. ## BitScheme To generate and run the BitScheme documentation, type: + +```shell +npm run bs:all ``` -$ npm run bs:all -``` + This will open the BitScheme.html file, and also run the documentation through the testdoc evaluator which will generate pass/fail messages. ## Development -1. Install the [Atom editor](http://flight-manual.atom.io/getting-started/sections/installing-atom/). +1. Clone the [github repository](https://github.com/TheSwanFactory/hclang.git). -2. Install the [language-maml](https://github.com/TheSwanFactory/language-maml) Atom package. +2. Install [node.js](https://nodejs.org/). -3. Clone the [github repository](https://github.com/TheSwanFactory/hclang.git). + * e.g., `brew install node` on macOS. -4. Install [node.js](https://nodejs.org/). - * e.g., `brew install node` on macOS. +3. Run `npm test`. -5. Run `npm test`. +NOTE: The [language-hclang](https://github.com/TheSwanFactory/language-hclang) vscode extension is still in development. -## Publishing +## Publishing From the feature branch: