Skip to content

Commit 39e43af

Browse files
committed
update README
1 parent 23c0cfc commit 39e43af

File tree

2 files changed

+17
-20
lines changed

2 files changed

+17
-20
lines changed

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ HTML.
1414
* _Math formula support:_ Inserting math formulas in pseudocode.js is as easy
1515
as LaTeX. Just enclose math expression in `$...$` or `\(...\)`.
1616

17-
It supports all modern browsers, including Chrome, Safari, Firefox, Edge, and
18-
IE 9 - IE 11.
17+
It supports all modern browsers, including Chrome, Safari, Firefox, Edge, and Edge.
1918

2019
Visit the [project website](https://saswatpadhi.github.io/pseudocode.js) for a demo.
2120

@@ -129,7 +128,7 @@ Insert the following Javascript snippet at the end of your document:
129128
</script>
130129
```
131130

132-
#### Step 4B &middot; Render the class using pseudocode.js
131+
#### Step 4B &middot; Render all elements of the class using pseudocode.js
133132
Insert the following Javascript snippet at the end of your document:
134133

135134
```html
@@ -198,38 +197,37 @@ and `<function>`:
198197
\COMMENT{<text>}
199198
```
200199

201-
A `<text>` (or `<condition>`) can include the following:
200+
A `<text>`, `<block>`, or `<condition>` may include the following:
202201
```tex
203-
# Normal characters
202+
% Normal characters
204203
Hello world
205-
# Escaped characters
204+
% Escaped characters
206205
\\, \{, \}, \$, \&, \#, \% and \_
207-
# Math formula
206+
% Math formula
208207
$i \gets i + 1$
209-
# Function call
208+
% Function call
210209
\CALL{<func>}{<args>}
211-
# Keywords
212-
\AND, \OR, \XOR, \NOT, \TO, \DOWNTO, \TRUE, \FALSE
213-
# LaTeX's sizing commands
210+
% Keywords
211+
\AND, \OR, \XOR, \NOT, \TO, \DOWNTO, \TRUE, \FALSE, \BREAK, \CONTINUE
212+
% LaTeX's sizing commands
214213
\tiny, \scriptsize, \footnotesize, \small \normalsize, \large, \Large, \LARGE,
215214
\huge, \HUGE
216-
# LaTeX's font declarations
215+
% LaTeX's font declarations
217216
\rmfamily, \sffamily, \ttfamily
218217
\upshape, \itshape, \slshape, \scshape
219218
\bfseries, \mdseries, \lfseries
220-
# LaTeX's font commands
219+
% LaTeX's font commands
221220
\textnormal{<text>}, \textrm{<text>}, \textsf{<text>}, \texttt{<text>}
222221
\textup{<text>}, \textit{<text>}, \textsl{<text>}, \textsc{<text>}
223222
\uppercase{<text>}, \lowercase{<text>}
224223
\textbf, \textmd, \textlf
225-
# And it's possible to group text with braces
224+
% And it's possible to group text with braces
226225
normal text {\small the size gets smaller} back to normal again
227226
```
228227

229-
Note that although pseudocode.js recognizes some LaTeX commands, it is by no
230-
means a full-featured LaTeX implementation in JavaScript.
231-
It only support a subset of LaTeX commands that are most relevant to
232-
typesetting algorithms.
228+
> **Note**
229+
> Although pseudocode.js recognizes some LaTeX commands, it is by no means a full-featured LaTeX implementation in JavaScript.
230+
> It only support a subset of LaTeX commands that are most relevant to typesetting algorithms.
233231
234232

235233
To display the caption of an algorithm, use `algorithm` environment as a 'float' wrapper :

docs/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,7 @@ <h3>Features</h3>
200200
</ul>
201201
</p>
202202

203-
<p>It supports all modern browsers, including Chrome, Safari,
204-
Firefox, Opera, and IE 8 - IE 11. </p>
203+
<p>It supports all modern browsers, including Chrome, Safari, Firefox, Opera, and Edge. </p>
205204

206205
<h3>Usage</h3>
207206

0 commit comments

Comments
 (0)