diff --git a/Cargo.toml b/Cargo.toml index 6f34749c..8dd81d51 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ repository = "https://github.com/trishume/syntect" keywords = ["syntax", "highlighting", "highlighter", "colouring", "parsing"] readme = "Readme.md" license = "MIT" -version = "0.6.0" +version = "0.7.0" authors = ["Tristan Hume "] exclude = [ "testdata/*", diff --git a/Readme.md b/Readme.md index 40f42122..bcb8b27b 100644 --- a/Readme.md +++ b/Readme.md @@ -14,7 +14,7 @@ It is currently mostly complete and can parse, interpret and highlight based on `syntect` is [available on crates.io](https://crates.io/crates/syntect). You can install it by adding this line to your `Cargo.toml`: ```toml -syntect = "0.6" +syntect = "0.7" ``` After that take a look at the [documentation](http://thume.ca/rustdoc/syntect/syntect/) and the [examples](https://github.com/trishume/syntect/tree/master/examples). @@ -24,7 +24,7 @@ After that take a look at the [documentation](http://thume.ca/rustdoc/syntect/sy ## Features/Goals - [x] Work with many languages (accomplished through using existing grammar formats) -- [ ] Highlight super quickly, as fast as Sublime Text (not there yet but matching most editors) +- [x] Highlight super quickly, faster than every editor except Sublime Text 3 - [x] Load up quickly, currently in around 23ms but could potentially be even faster. - [x] Include easy to use API for basic cases - [x] API allows use in fancy text editors with piece tables and incremental re-highlighting and the like. @@ -55,29 +55,31 @@ There's currently an example program called `syncat` that prints one of the sour - [x] Add nice API wrappers for simple use cases. The base APIs are designed for deep high performance integration with arbitrary text editor data structures. - [x] Document the API better and make things private that don't need to be public - [x] Detect file syntax based on first line +- [x] Make it really fast (mosty two hot-paths need caching, same places Textmate 2 caches) - [ ] Make syncat a better demo, and maybe more demo programs -- [ ] Make it really fast (mosty two hot-paths need caching, same places Textmate 2 caches) - [ ] Add sRGB colour correction (not sure if this is necessary, could be the job of the text editor) - [ ] Add C bindings so it can be used as a C library from other languages. ## Performance -Currently `syntect` is reasonably fast but not as fast as it could be. The following perf features are done and to-be-done: +Currently `syntect` is one of the faster syntax highlighting engines, but not the fastest. The following perf features are done and to-be-done: - [x] Pre-link references between languages (e.g `