Readme, license

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Graeme Phillips
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,70 @@
+# goldmark-qjs-katex
+
+This is an extension for [Goldmark](https://github.com/yuin/goldmark) that adds TeX rendering using KaTeX. It embeds QuickJS and QuickJS-compiled KaTeX bytecode.
+
+The parser follows pandoc's rules for TeX in markdown. Right now, `$` and `$$` are the only supported delimiters. Also, only KaTeX's default configuration is supported.
+
+### Performance
+
+```
+goos: windows
+goarch: amd64
+pkg: github.com/graemephi/goldmark-qjs-katex
+BenchmarkSequencesAndSeries/NoKaTeX-4              12210            981796 ns/op          381171 B/op       1497 allocs/op
+BenchmarkSequencesAndSeries/NoCache-4                 10        1069105530 ns/op         4900488 B/op       1563 allocs/op
+BenchmarkSequencesAndSeries/Cache-4                 5041           2329294 ns/op         4443003 B/op       1545 allocs/op
+```
+
+## Usage
+
+```
+import "github.com/graemephi/goldmark-qjs-katex"
+```
+```
+markdown := goldmark.New(
+	goldmark.WithExtensions(&qjskatex.Extension{}),
+)
+```
+
+Also, godoc.
+
+## Building
+
+If you just want to build, gcc must be installed, and all you need to do is
+
+```
+go build
+```
+
+However, if you modify `./katex/katex.js`, then you must recompile the JS source to bytecode with qjsc. qjsc can be compiled from source in `./katex/quickjs/`. In addition, if these modifications change the way TeX is rendered then you need to regenerate the test cases. This requires pandoc to be installed. Run
+
+```
+make
+```
+to do all that, or look in the Makefile to see how to do it.
+
+## Dependencies
+
+Goldmark, KaTeX, QuickJS.
+
+## Licenses
+
+### Goldmark
+```
+MIT License
+
+Copyright (c) 2019 Yusuke Inuzuka
+```
+### KaTeX
+```
+The MIT License (MIT)
+
+Copyright (c) 2013-2018 Khan Academy
+```
+### QuickJS
+```
+QuickJS is released under the MIT license.
+
+Unless otherwise specified, the QuickJS sources are copyright Fabrice
+Bellard and Charlie Gordon.
+```