Skip to content

Commit 5af75f7

Browse files
committed
Clean up README a bit
Add some links to external documents and update the status section a bit. Fixes #312.
1 parent 6da0fc4 commit 5af75f7

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,19 @@ more information.
1010

1111
### Status
1212

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

18-
The tree data structures are usable but their APIs will evolve as we try out
19-
various use cases. Converting to `Expr` is always possible and will be stable
20-
if that helps for your use case.
20+
The AST and tree data structures are usable but their APIs will evolve as we
21+
try out various use cases. Parsing to the standard `Expr` AST is always
22+
possible and will be stable.
23+
24+
The intention is to extend this library over time to cover more of the Julia
25+
compiler frontend.
2126

2227
# Getting involved
2328

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

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

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

0 commit comments

Comments
 (0)