From cfb1d4d78d7d0d9f6afe6a3013ccf482a145e2a9 Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" <19791+drernie@users.noreply.github.com> Date: Thu, 19 Sep 2024 19:52:09 -0700 Subject: [PATCH 1/2] lint README --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f250b672..91a3a0d0 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,31 @@ # 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) ## 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. It 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 @@ -33,11 +37,12 @@ This will open the BitScheme.html file, and also run the documentation through t 3. Clone the [github repository](https://github.com/TheSwanFactory/hclang.git). 4. Install [node.js](https://nodejs.org/). - * e.g., `brew install node` on macOS. + + * e.g., `brew install node` on macOS. 5. Run `npm test`. -## Publishing +## Publishing From the feature branch: From 8e107ac4e9633ac8e912aeca867d62fdc27d7dee Mon Sep 17 00:00:00 2001 From: "Dr. Ernie Prabhakar" <19791+drernie@users.noreply.github.com> Date: Thu, 19 Sep 2024 21:04:12 -0700 Subject: [PATCH 2/2] replace language extension --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 91a3a0d0..89e89431 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # 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 @@ -30,17 +32,15 @@ This will open the BitScheme.html file, and also run the documentation through t ## 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. - -3. Clone the [github repository](https://github.com/TheSwanFactory/hclang.git). - -4. Install [node.js](https://nodejs.org/). +2. Install [node.js](https://nodejs.org/). * e.g., `brew install node` on macOS. -5. Run `npm test`. +3. Run `npm test`. + +NOTE: The [language-hclang](https://github.com/TheSwanFactory/language-hclang) vscode extension is still in development. ## Publishing