Skip to content

Commit

Permalink
Clean up README a bit
Browse files Browse the repository at this point in the history
Add some links to external documents and update the status section a
bit. Fixes #312.
  • Loading branch information
c42f committed Jul 1, 2023
1 parent 6da0fc4 commit 5af75f7
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,19 @@ more information.

### Status

JuliaSyntax.jl is highly compatible with the Julia reference parser: It parses
all of Base, the standard libraries and General registry. Some minor difference
remain where we've decided to fix bugs or strange behaviors in the reference
parser.
JuliaSyntax.jl is used as the new default Julia parser in Julia 1.10.
It's highly compatible with Julia's older
[femtolisp-based parser](https://github.com/JuliaLang/julia/blob/master/src/julia-parser.scm) -
It parses all of Base, the standard libraries and General registry. Some minor
difference remain where we've decided to fix bugs or strange behaviors in the
reference parser.

The tree data structures are usable but their APIs will evolve as we try out
various use cases. Converting to `Expr` is always possible and will be stable
if that helps for your use case.
The AST and tree data structures are usable but their APIs will evolve as we
try out various use cases. Parsing to the standard `Expr` AST is always
possible and will be stable.

The intention is to extend this library over time to cover more of the Julia
compiler frontend.

# Getting involved

Expand All @@ -27,8 +32,10 @@ https://github.com/JuliaLang/JuliaSyntax.jl/issues and choosing a small issue
or two to work on to familiarize yourself with the code. Anything marked with
the labels `intro issue` or `bug` might be a good place to start.

Also watching the 2022 JuliaCon talk and reading this document is probably good
for an overview.
Also watching the [2022 JuliaCon talk](https://www.youtube.com/watch?v=CIiGng9Brrk)
and reading the [design](https://julialang.github.io/JuliaSyntax.jl/dev/design/) and
[reference](https://julialang.github.io/JuliaSyntax.jl/dev/reference/)
documentation should be good for an overview.

As of May 2023, we've got really good positional tracking within the source,
but JuliaSyntax really needs a better system for parser recovery before the
Expand Down

0 comments on commit 5af75f7

Please sign in to comment.