An interpreter for arcscript using antlr4
npm install @arcweave/arcscript!NPM Version
!GitHub Actions Workflow Status
> Write a project description
This project requires NodeJS (version 8 or later) and NPM.
Node and NPM are really easy to install.
To make sure you have them available on your machine,
try running the following command.
``sh`
$ npm -v && node -v
6.4.1
v8.16.0
- JS Arcscript Interpreter
- Prerequisites
- Table of contents
- Getting Started
- Installation
- Usage
- Building the app
- Running the tests
- API
- Contributing
- Credits
- License
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
BEFORE YOU INSTALL: please read the prerequisites
Start with cloning this repo on your local machine:
`sh`
$ git clone https://github.com/arcweave/arcscript-interpreters.git
$ cd arcscript-interpreters/JavaScript
To install and set up the library, run:
`sh`
$ npm install -S @arcweave/arcscript
Or if you prefer using Yarn:
`sh`
$ yarn add --dev @arcweave/arcscript
`sh`
$ npm run build
`sh`
$ npm test
This task will create a distribution version of the project
inside your local dist/ folder
TODO: Write API
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
1. Fork it!
2. Create your feature branch: git checkout -b my-new-featuregit add .
3. Add your changes: git commit -am 'Add some feature'
4. Commit your changes: git push origin my-new-feature`
5. Push to the branch:
6. Submit a pull request
TODO: Write credits
TODO: Write license