Skip to content

DogeTheBeast/Trick

Repository files navigation


Logo

Trick

A custom OOP language compiler written in Java

View Demo

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

About The Project

As engineers, programming languages always seemed like a sort of black box to us. Therefore, we started this project because of our curiosity into compiler design and optimizations and to better understand how compilers work under the hood.

Built With

This project was built with the following frameworks:

  • Java
  • Gradle
  • TeaVM

Getting Started

To run Trick locally, follow these steps (for UNIX based systems):

Prerequisites

Make sure you have the following packages downloaded *Java *Gradle

Installation

  1. Clone the repo
    git clone https://github.com/dogethebeast/trick.git
  2. Navigate into the cloned repository
    cd trick
  3. Build the project
    ./gradlew build
  4. Run the compiler either with a file for in REPL (Read Eval Print Loop) mode
    ./gradlew run #Figure out how to pass in file
    ./gradlew run #REPL

Usage

Before cloning, you can check out the compiler on your browser by visiting this webpage.

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Roadmap

  • Complete README.md
  • Test error reporting
  • Test blob reporting

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

Contact

Ratiq Narwal - @ratiqnarwal - ratiqnarwal@gmail.com

Youssef Chaabani - @youssefchaabani - ychaabani@gmail.com

Acknowledgments

Resources that were useful while building this project.

About

Custom OOP language compiler written in Java

Topics

Resources

Stars

Watchers

Forks

Contributors