Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

shakelang/parseutils

Repository files navigation

ARCHIVED

This package is now included in the shake main repository (https://github.com/shakelang/shake)

Contributors Forks Stargazers Issues BSD-2-Clause


header-image sub-header-image

This package provides tools for parsing code
these tools are for example used by the shake compiler & interpreter

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Building
  5. Roadmap
  6. Contributing
  7. License

About The Project

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You should be using Gradle, Maven or something similar to import this as a dependency, or you can download a release from here and link manually inside your IDE

Installation

Add the dependency using gradle

dependencies {
    implementation 'com.github.shakelang.parseutils:lib:0.1.0'
}

if you use a kotlin build script

dependencies {
    implementation("com.github.shakelang.parseutils:lib:0.1.0")
}

Usage

...

For more examples, please refer to the Documentation

Building

First clone the repository using git clone https://shakelang.github.io/parseutils

If you are on linux you need to make the build script executable using

chmod +x gradlew

now just build the project using

./gradlew build

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the BSD-2-Clause License. See LICENSE for more information.