Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

188 update readme #212

Merged
merged 2 commits into from
Sep 20, 2024
Merged

188 update readme #212

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfb1d4d
lint README
drernie Sep 20, 2024
8e107ac
replace language extension
drernie Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
Loading