Commit graph

41 commits

Author SHA1 Message Date
ObserverOfTime
88e0b4cea4 docs: change WASM/wasm to Wasm
That is the official capitalisation.
2025-08-21 09:56:32 +03:00
laur89
e8d3d01598
docs: fix CLI link in readme (#4514) 2025-06-13 11:11:44 -07:00
Nathan M
aa0f3c21b1
docs: add discord and matrix badges 2024-03-10 11:28:14 -04:00
dundargoc
df1fe842eb docs: various fixes
Closes https://github.com/tree-sitter/tree-sitter/issues/1317.
Closes https://github.com/tree-sitter/tree-sitter/issues/1752.
Closes https://github.com/tree-sitter/tree-sitter/issues/2439.

Co-authored-by: Simon Hengel <sol@typeful.net>
Co-authored-by: Akash Yadav <itsaky01@gmail.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: Laytan Laats <laytanlaats@hotmail.com>
2024-02-08 00:08:59 +01:00
Andrew Hlynskyi
613382c70a docs: update badges; fix markdown lint complains
Linter config `.vscode/settings.json`:
```json
{
    "[markdown]": {
        "files.trimTrailingWhitespace": false,
    },
    "markdownlint.config": {
        "default": true,
        // "ul-style": {
        //     "style": "asterisk"
        // },
        "MD001": false,
        "MD024": false,
        "MD025": false,
        "MD033": false,
        "MD041": false,
        "MD053": false,
    },
}
```
2023-04-16 23:39:08 +03:00
Andrew Hlynskyi
34a83dfe69 cicd: update status badge 2023-04-04 03:42:58 +03:00
Andrew Hlynskyi
78fd9196f7 ci: drop AppVeyor and its badge 2023-03-16 17:29:27 +02:00
Max Brunsfeld
56c7c6b39d Add zenodo citation badge to readme 2021-03-18 12:16:03 -07:00
Max Brunsfeld
23b41862ab Put GH actions badge in the README 2021-02-05 12:22:46 -08:00
Max Brunsfeld
f38f5d1d22 Tweak readmes 2020-05-12 16:16:48 -07:00
Max Brunsfeld
67fa9bdf4d
Use https README docs site link 2019-04-30 13:00:27 -07:00
Max Brunsfeld
308016b776 Clarify runtime vs parser generator in README
Fixes #182
2018-07-10 14:09:22 -07:00
Max Brunsfeld
5b18fe672b Link to the documentation site from the README 2018-06-12 17:43:55 -07:00
Max Brunsfeld
cd55d5275d Update the readme to reflect the new API 2018-05-11 12:48:51 -07:00
Max Brunsfeld
10a3cbd814 Move grammar schema to src folder
Now that there's a docs folder that contains actual docs.
2018-02-26 00:40:20 -08:00
Max Brunsfeld
da20ddf70e
Tweak README 2018-02-19 14:16:11 -08:00
Max Brunsfeld
3bda284656 Add Practical Algorithms thesis to references in README 2018-01-23 17:20:15 -08:00
Amila Welihinda
476b6d31b1
Changed travis repo badge to svg 2018-01-10 13:44:23 -08:00
Greg Price
704b8ad810 README: Make the examples work despite variation in out/*/ structure.
Fixes #102.  While on macOS the `libcompiler.a` and `libruntime.a`
files apparently get output directly into `out/Release/` by the build,
on Linux they seem to go into a subdirectory `out/Release/obj.target/`.

This causes someone who tries to follow the instructions to get an
error like
```
/usr/bin/ld: cannot find -lcompiler
clang: error: linker command failed with exit code 1 (use -v to see invocation)
```

That looks like the setup is broken somehow, and for someone who
hasn't spent much time fixing up Unix linker errors, it doesn't give a
lot of clues as to how to fix it.

Instead, have the recommended command find the actual library file
directly, and pass that to the linker.  (Alternatively we could have
passed the containing directory to `-L`; this is a little shorter, and
of course neither version is what you'd want in an industrial-strength
build recipe.)

This isn't the world's most elegant solution, obviously -- it'd be
better (at least as far as this part is concerned) to have the layout
be the same on different platforms.  But doing that sounds likely to
require significant messing around with build scripts, so this at
least makes the instructions work reliably.
2017-10-30 22:23:40 -07:00
Greg Price
6bfe95fc95 README: Consistently use Release in examples.
Following the instructions in the README from the top, I don't
get a `Debug` build directory, only `Release`.  So, stick to that.
2017-10-28 23:41:11 -07:00
Greg Price
276ca6ab8a README: Fix the order of sources/libraries in example compilation commands.
Some linkers (among them, the GNU ld 2.28 on my laptop, which clang
relies on for linking) are picky about the order they get their
ingredients in on the command line.  When they are, they want the
leaf nodes (like your `main` function) first, and the dependencies
(like `libcompiler.a`) after.

It's kind of counterintuitive (at least to me) that this is the
preferred order, though I can understand it from the perspective
of efficient resource use in the era when some linkers were first
written.  Anyway, it's the way it is.  There's a detailed
explanation here:
  https://stackoverflow.com/a/409470/378130

So, adjust the examples in the README to an order that should
work everywhere.

This fixes part of #102.
2017-10-28 23:41:11 -07:00
Josh Vera
a2121cf01f Change link from paywalled version 2017-10-16 17:29:53 -04:00
ZachTRice
50e9520133 Updated links in References
The links to http://harmonia.cs.berkeley.edu got to a "forbidden, you' dont have permission to access..." error page. I have updated "Efficient and Flexible Incremental Parsing" to point to the ftp location on berkeley.edu. The only hosted reference to "Incremental Analysis of Real Programming Languages" is at ACM Digital Library, I pointed the link here.
2017-10-16 17:17:49 -04:00
Rob Rix
10111cc206 Update the link to the paper
The old link has gone stale.
2017-10-02 10:54:06 -04:00
Max Brunsfeld
fc4c6723b8 Add appveyor badge to README 2017-08-09 10:29:15 -07:00
Max Brunsfeld
d73534e97d Update language function name in README 2017-01-31 11:41:46 -08:00
Max Brunsfeld
400e689bdd Update README to reflect API changes 2016-09-12 11:02:09 -07:00
Max Brunsfeld
88e8cab7f9 Remove all mention of the ERROR rule type 2016-09-01 16:34:44 -07:00
Max Brunsfeld
afed91661b Update repo URLs in readme 2016-02-12 13:10:38 -08:00
Max Brunsfeld
04afda2e66 Drop extensions from script filenames 2016-01-15 13:01:19 -08:00
Max Brunsfeld
569b9d4099 Allow comments within grammar JSON 2016-01-14 11:28:13 -08:00
Max Brunsfeld
bc56729b8b Fix JSON syntax error in README grammar 2016-01-14 10:17:37 -08:00
Max Brunsfeld
7121689cfe Update README to reflect new compiler API 2016-01-13 20:52:58 -08:00
Max Brunsfeld
1c6ad5f7e4 Rename ubiquitous_tokens -> extra_tokens in compiler API
They were already called this in the runtime code.
'Extra' is just easier to say.
2015-12-17 15:50:50 -08:00
Max Brunsfeld
b3a6de6dad Replace node pos/size functions with start/end char/byte functions 2015-12-03 22:59:27 -08:00
Max Brunsfeld
a8817d38b2 Add link to other Wagner & Graham paper to README 2015-11-11 19:49:17 -08:00
Max Brunsfeld
84fe01e145 Update README to reflect API changes 2015-10-16 00:15:25 -07:00
Max Brunsfeld
736c78b095 Update readme 2015-09-10 11:43:55 -07:00
Max Brunsfeld
4d17da159f repo name tree_sitter -> tree-sitter 2014-07-13 22:14:03 -07:00
maxbrunsfeld
e681a63552 Add references to readme 2014-03-09 12:28:18 -07:00
maxbrunsfeld
19804367b3 Create README.md 2014-02-19 09:28:31 -08:00