JS Arcscript Interpreter

Table of contents

• JS Arcscript Interpreter
  • Table of contents
  • Getting Started
  • Installation
  • Usage
    • Building the app
    • Running the tests
  • API
  • Contributing
  • Credits
  • License

Getting Started

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.

Installation

To include @arcweave/arcscript in your project, you can use npm:

$ npm install -S @arcweave/arcscript

Usage

Building the app

$ pnpm install
$ pnpm run build

This task will create a distribution version of the project inside your local dist/ folder

Running the tests

$ pnpm test

API

TODO: Write API

Contributing

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-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request

Credits

TODO: Write credits

License

TODO: Write license