Skip to content

Commit

Permalink
An instructions related to named-readtables were added to the documen…
Browse files Browse the repository at this point in the history
…tation.
  • Loading branch information
svetlyak40wt authored and stassats committed May 9, 2018
1 parent 9e29e04 commit bfb3e28
Showing 1 changed file with 13 additions and 19 deletions.
32 changes: 13 additions & 19 deletions docs/index.html
Expand Up @@ -40,6 +40,8 @@ <h2>CL-INTERPOL - String interpolation for Common Lisp</h2>
into literal strings even if your editor/IDE doesn't support them.
Here's an example:
<pre>
* (ql:quickload :cl-interpol)
* (named-readtables:in-readtable :interpol-syntax)
* (let ((a 42))
#?&quot;foo: \xC4\N{Latin capital letter U with diaeresis}\nbar: ${a}&quot;)
&quot;foo: &Auml;&Uuml;
Expand Down Expand Up @@ -87,39 +89,31 @@ <h2>CL-INTERPOL - String interpolation for Common Lisp</h2>

CL-INTERPOL together with this documentation can be downloaded from <a
href="https://github.com/edicl/cl-interpol/archive/master.zip">Github</a>. The
current version is 0.2.2.
current version is 0.2.6.
<p>
CL-INTERPOL comes with a system definition for <a
href="http://www.cliki.net/asdf">ASDF</a> so you can install the library with
<pre>
(asdf:oos 'asdf:load-op :cl-interpol)
(asdf:load-system :cl-interpol)
</pre>
if you've unpacked it in a place where ASDF can find it. It depends on <a href="https://github.com/edicl/cl-unicode/">CL-UNICODE</a>. Installation
via <a href="http://www.cliki.net/asdf-install">asdf-install</a>
if you've unpacked it in a place where ASDF can find it. It depends on <a href="https://github.com/edicl/cl-unicode/">CL-UNICODE</a> and <a href="https://github.com/melisgl/named-readtables">NAMED-READTABLES</a>. Installation
via <a href="http://www.cliki.net/asdf-install">asdf-install</a> or
<a href="https://www.quicklisp.org/beta/">Quicklisp</a>
should also be possible.
<p>
<b>Note:</b> Before you can actually <em>use</em> the new reader
syntax you have to enable it with <a
href="#enable-interpol-syntax"><code>ENABLE-INTERPOL-SYNTAX</code></a>.
syntax you have to enable it with
<a href="#enable-interpol-syntax"><code>ENABLE-INTERPOL-SYNTAX</code></a>
or via named-readtables:
<pre>(named-readtables:in-readtable :interpol-syntax)</pre>

<p>
You can run a test suite which tests most aspects of the library with
<pre>
(asdf:oos 'asdf:test-op :cl-interpol)
(asdf:test-system :cl-interpol)
</pre>
The test suite depends on <a href="https://github.com/edicl/flexi-streams/">FLEXI-STREAMS</a>.
<p>
The current development version of CL-INTERPOL can be found
at <a href="http://bknr.net/trac/browser/trunk/thirdparty">http://bknr.net/trac/browser/trunk/thirdparty</a>.
This is the one to send <a href="#mail">patches</a> against. Use at
your own risk.
<p>
Lu&iacute;s Oliveira maintains an unofficial <a href="http://darcs.net/">darcs</a>
repository of CL-INTERPOL
at <a
href="http://common-lisp.net/~loliveira/ediware/">http://common-lisp.net/~loliveira/ediware/</a>.

<br>&nbsp;<br><h3><a name="mail" class=none>Support</a></h3>

The development version of cl-interpol can be found <a href="https://github.com/edicl/cl-interpol" target="_new">on
github</a>. Please use the github issue tracking system to
submit bug reports. Patches are welcome, please use <a href="https://github.com/edicl/cl-interpol/pulls">GitHub pull
Expand Down

0 comments on commit bfb3e28

Please sign in to comment.