parser/README.md

# Trunk

A set of libraries for working with PHP in Rust.

## Overview

I originally started with this repository as an experiment. I wanted to see how feasible a handwritten PHP parser would be.

The goal was to have a set of tools that I could use to write my own utilities. The folders and crates in this repository serve as a guideline and target for the project.

## Goals

* [ ] **A full-featured lexer and parser for PHP 8.1+**
* [ ] An experimental runtime for PHP (excl. extensions)
* [ ] A static-analyser for PHP code.

> Bold text indicates the current goal.

## Contributing

All contributions are welcome. Please open a pull request with a descriptive title and description.

Please ensure all tests are passing on your pull request and that you add tests to cover your new feature or bug fix.

## Credits

* [Ryan Chandler](https://github.com/ryangjchandler)
docs: README 2022-07-20 21:35:03 +02:00			`# Trunk`

			`A set of libraries for working with PHP in Rust.`

			`## Overview`

			`I originally started with this repository as an experiment. I wanted to see how feasible a handwritten PHP parser would be.`

			`The goal was to have a set of tools that I could use to write my own utilities. The folders and crates in this repository serve as a guideline and target for the project.`

			`## Goals`

docs: README 2022-07-20 21:36:39 +02:00			`* [ ] A full-featured lexer and parser for PHP 8.1+`
docs: README 2022-07-20 21:35:03 +02:00			`* [ ] An experimental runtime for PHP (excl. extensions)`
			`* [ ] A static-analyser for PHP code.`

docs: README 2022-07-20 21:36:39 +02:00			`> Bold text indicates the current goal.`

docs: README 2022-07-20 21:35:03 +02:00			`## Contributing`

			`All contributions are welcome. Please open a pull request with a descriptive title and description.`

			`Please ensure all tests are passing on your pull request and that you add tests to cover your new feature or bug fix.`

			`## Credits`

			`* [Ryan Chandler](https://github.com/ryangjchandler)`