Skip to content

Commit

Permalink
Updated documentation for ArgoUML, Saxon installation.
Browse files Browse the repository at this point in the history
  * argouml-installation.html: added download, Java sections.
  * installation.html: added Java section.
  * saxon-installation.html: added <hr/>s for clarity.
  • Loading branch information
simonjwright committed Jul 9, 2023
1 parent 94a1703 commit 95b0445
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 3 deletions.
25 changes: 22 additions & 3 deletions argouml-installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ <h1>ColdFrame: ArgoUML installation</h1>
<h2>Contents</h2>

<ul>
<li>Default settings

<li><a href=="#java">Java</a>
<li><a href=="#download">Download</a>
<li><a href=="#default-settings">Default settings</a>
<ul>
<li><a href="#user">User tab</a>
<li><a href="#profiles">Profiles tab</a>
Expand All @@ -27,11 +30,27 @@ <h2>Contents</h2>
<li><a href="#project-properties">Project Properties</a>
</ul>

<h2>Default settings</h2>
<h2><a name="java">Java</a></h2>

<p>You can download two different flavours of Java; SE and OpenJDK. For <a href="https://github.com/argouml-tigris-org/argouml/issues/51">reasons</a>, at any rate on macOS, the <a href=="#default-settings">default settings</a> option is invisible under OpenJDK, so it's probably best to stick with SE. This is the 'Download Java" button <a href="https://www.java.com">here</a>.

<h2><a name="download">Download</a></h2>

<p>You can find copies of the old releases <a href="https://github.com/argouml-tigris-org/argouml/releases/tag/VERSION_0_35_1">here</a>.

<p>For macOS, you might have expected that <tt>ArgoUML-0.35.1.app.tar.gz</tt> would have been the thing, but (at any rate on Ventura) it won't unpack into <tt>~/tmp</tt>, and even if unpacked onto an external disk macOS claims it's damaged and won't open it.

<p>Instead, download <tt>ArgoUML-0.35.1.tar.gz</tt> and unpack to a convenient place, then
<pre>
java -jar <i>/where/ever/</i>argouml-0.35.1/argouml.jar
</pre>
<p>(this will result in a <em>lot</em> of logging output).

<h2><a name="default-settings">Default settings</a></h2>

<p>On Linux and (probably) Windows, you can set up ColdFrame-specific
and ColdFrame-recommended defaults in the <i>Edit/Settings</i>
menu. On Mac OS X, use <i>Main/Preferences</i>.
menu. On macOS, use <i>Main/Preferences</i>.

<h4><a name="user">User tab</a></h4>

Expand Down
3 changes: 3 additions & 0 deletions installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ <h2>Prerequisites</h2>
noreferrer">GNAT</a> (an Ada 95/2005/2012/2022 compiler; must support
Ada2005 or later)

<li><a href="https://jdk.java.net" target="_blank" rel-"noopeneer
noreferrer">Java</>

<li><a href="https://python.org" target="_blank" rel="noopener
noreferrer">Python 3</a>

Expand Down
6 changes: 6 additions & 0 deletions saxon-installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@

<h1>ColdFrame: Saxon installation</h1>

<hr/>

<p>If you're on a Mac using <a href="https://brew.sh">Homebrew</a>,
just <tt>brew install saxon</tt> (and, if you haven't
already, <tt>brew install graphviz</tt>): set the environment
variable <tt>SAXON</tt> to <tt>saxon</tt> (you could make this
permanent in ColdFrame's <tt>Makefile.inc</tt>).

<hr/>

<p>Otherwise, we
need <a href="https://www.saxonica.com/products/PD12/SaxonJ-HE.pdf">Saxon
HE for Java</a> (Home Edition - paid-for versions are available, but
Expand Down Expand Up @@ -71,5 +75,7 @@ <h1>ColdFrame: Saxon installation</h1>

<p>so you could set up your own <tt>SAXON_CLASSPATH</tt> instead.

<hr/>

</body>
</html>

0 comments on commit 95b0445

Please sign in to comment.