README.md

jlox

Java implementation of the Lox programming language
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A Java implementation of the Lox programming language. This is directly from Bob Nystrom's site Crafting Interpreters.

Getting Started

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

Prerequisites

None. This will work with Java 8 or higher.

Installation

Clone the repo

git clone https://github.com/bigangryguy/jlox.git

Usage

For now, reference the Lox grammar appendix on the Crafting Interpreters site. In the future, as cloxplus adds new features and forks from the original language specification, a full grammar reference will be included here.

Roadmap

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

This is a completion of the project. A continued implementation of the Lox language in C++, with plans for extensions to the original language specification, can be found in my cloxplus project.

Contributing

Contributions are what make the open source community such an amazing place to be 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 MIT License. See LICENSE.md for more information.

Contact

David Wilcox - @davidtwilcox - david@dtwil.co

Project Link: https://github.com/bigangryguy/jlox

Acknowledgements

• Bob Nystrom - Author of Crafting Interpreters