Skip to content

Commit 5ceb032

Browse files
Improve the README with a conditional note about the GitHub mirror.
FossilOrigin-Name: e93079ea62d23c780d22a373b99e40a51cbec936747e9df2f31bca6f17a6b3f8
1 parent 8f3ada4 commit 5ceb032

File tree

2 files changed

+89
-58
lines changed

2 files changed

+89
-58
lines changed

README.adoc

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
= Solo Forth
22
:author: Marcos Cruz (programandala.net)
3-
:revdate: 2021-01-16
4-
:toc:
3+
:revdate: 2021-02-02
4+
:toc: macro
55
:linkattrs:
66

77
// This file is part of Solo Forth
88
// http://programandala.net/en.program.solo_forth.html
99

10-
// Last modified: 202101162124.
10+
// Last modified: 202102022010.
11+
12+
ifdef::env-github[]
13+
14+
NOTE: This is the GitHub mirror of the
15+
http://fossil.programandala.net/solo_forth[Solo Forth repository],
16+
which uses http://fossil-scm.org[Fossil].
17+
18+
'''
19+
20+
endif::[]
21+
22+
// XXX FIXME 2021-02-02: The layout of the ToC title is ruined on the
23+
// Fossil repo when the ToC is placed by `:toc: macro`:
24+
25+
toc::[]
1126

1227
// Description {{{1
1328
== Description

doc/www/README.html

+71-55
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<div class='fossil-doc' data-title='README'>
2+
<div id="preamble">
3+
<div class="sectionbody">
24
<div id="toc" class="toc">
3-
<div id="toctitle">Table of Contents</div>
5+
<div id="toctitle" class="title">Table of Contents</div>
46
<ul class="sectlevel1">
57
<li><a href="#_description">Description</a>
68
<ul class="sectlevel2">
@@ -29,6 +31,8 @@
2931
<li><a href="#_documentation">Documentation</a></li>
3032
</ul>
3133
</div>
34+
</div>
35+
</div>
3236
<div class="sect1">
3337
<h2 id="_description">Description</h2>
3438
<div class="sectionbody">
@@ -482,6 +486,59 @@ <h4 id="_on_zx_spectrum_1282_with_the_plus_d_interface">On ZX Spectrum 128/+2 wi
482486
</div>
483487
<div class="sect2">
484488
<h3 id="_run_trdos">In TR-DOS</h3>
489+
<div class="admonitionblock important">
490+
<table>
491+
<tr>
492+
<td class="icon">
493+
<div class="title">Important</div>
494+
</td>
495+
<td class="content">
496+
<div id="trdosdiskdrives" class="paragraph">
497+
<p>The TR-DOS version of Solo Forth uses numbers as disk drive
498+
identifiers (the same numbers TR-DOS uses internally) instead of the
499+
letters used by the TR-DOS BASIC interface:</p>
500+
</div>
501+
<table class="tableblock frame-all grid-all stretch">
502+
<caption class="title">Table 3. TR-DOS disk drive identifiers</caption>
503+
<colgroup>
504+
<col style="width: 33.3333%;">
505+
<col style="width: 33.3333%;">
506+
<col style="width: 33.3334%;">
507+
</colgroup>
508+
<thead>
509+
<tr>
510+
<th class="tableblock halign-left valign-top">Drive</th>
511+
<th class="tableblock halign-left valign-top">In TR-DOS</th>
512+
<th class="tableblock halign-left valign-top">In Solo Forth</th>
513+
</tr>
514+
</thead>
515+
<tbody>
516+
<tr>
517+
<td class="tableblock halign-left valign-top"><p class="tableblock">1st</p></td>
518+
<td class="tableblock halign-left valign-top"><p class="tableblock">A</p></td>
519+
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
520+
</tr>
521+
<tr>
522+
<td class="tableblock halign-left valign-top"><p class="tableblock">2nd</p></td>
523+
<td class="tableblock halign-left valign-top"><p class="tableblock">B</p></td>
524+
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
525+
</tr>
526+
<tr>
527+
<td class="tableblock halign-left valign-top"><p class="tableblock">3rd</p></td>
528+
<td class="tableblock halign-left valign-top"><p class="tableblock">C</p></td>
529+
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
530+
</tr>
531+
<tr>
532+
<td class="tableblock halign-left valign-top"><p class="tableblock">4th</p></td>
533+
<td class="tableblock halign-left valign-top"><p class="tableblock">D</p></td>
534+
<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td>
535+
</tr>
536+
</tbody>
537+
</table>
538+
</td>
539+
</tr>
540+
</table>
541+
</div>
485542
<div class="sect3">
486543
<h4 id="_on_pentagon_128">On Pentagon 128</h4>
487544
<div class="olist arabic">
@@ -664,74 +721,33 @@ <h3 id="_in_tr_dos">In TR-DOS</h3>
664721
<p><a href="#_run_trdos">Run Solo Forth</a>.</p>
665722
</li>
666723
<li>
667-
<p>“Insert” the file &lt;disks/trdos/disk_1a_library.trd&gt; into the second
668-
disk drive (called B in TR-DOS and 1 in Solo Forth), and the file
669-
&lt;disks/trdos/disk_1b_library.trd&gt; into the third disk drive (called
670-
C in TR-DOS and 2 in Solo Forth).</p>
724+
<p>“Insert” the file &lt;disks/trdos/disk_1a_library.trd&gt; into the first
725+
disk drive (called A in TR-DOS and 0 in Solo Forth), and the file
726+
&lt;disks/trdos/disk_1b_library.trd&gt; into the second disk drive (called
727+
B in TR-DOS and 1 in Solo Forth).</p>
671728
<div class="openblock">
672729
<div class="content">
673730
<div class="paragraph">
674731
<p>Notice that the library is split into two disks because the maximun
675732
capacity of a TR-DOS disk is only 640 KiB.</p>
676733
</div>
677734
<div class="paragraph">
678-
<p>Also notice that the TR-DOS version of Solo Forth uses numbers as disk
679-
drive identifiers (the same numbers TR-DOS uses internally) instead of
680-
the letters used by the TR-DOS BASIC interface:</p>
735+
<p>Also remember in Solo Forth the <a href="#trdosdiskdrives">TR-DOS disk drive
736+
identifiers</a> are numbers 0..3 instead of letters A..D.</p>
681737
</div>
682-
<table class="tableblock frame-all grid-all stretch">
683-
<caption class="title">Table 3. TR-DOS disk drive identifiers</caption>
684-
<colgroup>
685-
<col style="width: 33.3333%;">
686-
<col style="width: 33.3333%;">
687-
<col style="width: 33.3334%;">
688-
</colgroup>
689-
<thead>
690-
<tr>
691-
<th class="tableblock halign-left valign-top">Drive</th>
692-
<th class="tableblock halign-left valign-top">In TR-DOS</th>
693-
<th class="tableblock halign-left valign-top">In Solo Forth</th>
694-
</tr>
695-
</thead>
696-
<tbody>
697-
<tr>
698-
<td class="tableblock halign-left valign-top"><p class="tableblock">1st</p></td>
699-
<td class="tableblock halign-left valign-top"><p class="tableblock">A</p></td>
700-
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
701-
</tr>
702-
<tr>
703-
<td class="tableblock halign-left valign-top"><p class="tableblock">2nd</p></td>
704-
<td class="tableblock halign-left valign-top"><p class="tableblock">B</p></td>
705-
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
706-
</tr>
707-
<tr>
708-
<td class="tableblock halign-left valign-top"><p class="tableblock">3rd</p></td>
709-
<td class="tableblock halign-left valign-top"><p class="tableblock">C</p></td>
710-
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
711-
</tr>
712-
<tr>
713-
<td class="tableblock halign-left valign-top"><p class="tableblock">4th</p></td>
714-
<td class="tableblock halign-left valign-top"><p class="tableblock">D</p></td>
715-
<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td>
716-
</tr>
717-
</tbody>
718-
</table>
719738
</div>
720739
</div>
721740
</li>
722741
<li>
723-
<p>Type <code>1 set-drive throw</code> to make drive 1 (i.e. the second one,
724-
called B by TR-DOS) the current one.</p>
742+
<p>Type <code>1 load</code> to load block 1 from the first library disk. By
743+
convention, block 0 cannot be loaded (it is used for comments), and
744+
block 1 is used as a loader. In Solo Forth, block 1 contains <code>2
745+
load</code>, in order to load the <code>need</code> tool from block 2.</p>
725746
</li>
726747
<li>
727-
<p>Type <code>1 load</code> to load block 1 from the library disk. By convention,
728-
block 0 cannot be loaded (it is used for comments), and block 1 is
729-
used as a loader. In Solo Forth, block 1 contains <code>2 load</code>, in
730-
order to load the <code>need</code> tool from block 2. Type <code>need
731-
set-block-drives</code> to load the word <code>set-block-drives</code> from the
732-
library. Then type <code>2 1 2 set-block-drives</code> to configure the second
733-
and the third drives (i.e. drives 1 and 2 in Solo Forth, called B
734-
and C in the TR-DOS BASIC interface) as block drives.</p>
748+
<p>Type <code>need 2-block-drives</code> to load and execute the word
749+
<code>2-block-drives</code> from the library, setting the first two drives as
750+
block drives in their normal order.</p>
735751
</li>
736752
<li>
737753
<p>Type <code>need name</code>, were “name” is the name of the word or tool you

0 commit comments

Comments
 (0)