Skip to content

Commit

Permalink
Fix some typos in docs/DafnyRef/README.md (#5099)
Browse files Browse the repository at this point in the history
  • Loading branch information
kazarmy authored Feb 19, 2024
1 parent be07874 commit ce761e7
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/DafnyRef/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ subfolders. In order to render files locally you must
* set the working directly (`cd`) to the `docs` folder (Windows or Ruby 3.0 users, see below for some tweaks)
* run the jekyll server: `bundle exec jekyll server`
* open a browser on the page http://localhost:4000 or directly to http://localhost:4000/DafnyRef/DafnyRef
* the server rerenders when files are changed -- but not always quite completely. Sometimes one must kill the server process, delete all the files in the _saite folder, and restart the server.
* the server rerenders when files are changed -- but not always quite completely. Sometimes one must kill the server process, delete all the files in the _site folder, and restart the server.

In order to convert markdown to pdf, you must be able to execute the Makefile, which requires installing pandoc and LaTeX, and being on a Linux-like platform.

Expand Down Expand Up @@ -64,12 +64,11 @@ definition file.
## On-line RM through github
Github uses rouge, via Jekyll. The syntax definition is a ruby-based file
maintained in the rouge github repo.
To modify the definition, follow the directions in
[https://rouge-ruby.github.io/docs/file.LexerDevelopment.html]
(https://rouge-ruby.github.io/docs/file.LexerDevelopment.html)
after setting up a development environment according to
[https://rouge-ruby.github.io/docs/file.DevEnvironment.html]
(https://rouge-ruby.github.io/docs/file.DevEnvironment.html).
To modify the definition, follow
[these](https://rouge-ruby.github.io/docs/file.LexerDevelopment.html)
directions after [setting
up](https://rouge-ruby.github.io/docs/file.DevEnvironment.html) a
development environment.
The file itself, `dafny.rb` is in Ruby. Details of the Ruby Regular
Expression language can be found many places online, such as
[here](https://www.princeton.edu/~mlovett/reference/Regular-Expressions.pdf).
Expand Down Expand Up @@ -113,4 +112,4 @@ file as well.
## LSP

Many IDEs interact with Language Servers (via LSP). Possibly an LSP protocol
will be generated in the future.
will be generated in the future.

0 comments on commit ce761e7

Please sign in to comment.