Permalink
Browse files

Updating index and download page to reflect docker availability

  • Loading branch information...
TimLethbridge committed Oct 19, 2017
1 parent 39c913f commit 37976df4b2a8a02d928f429bb6a85eca35c45ec7
Showing with 91 additions and 53 deletions.
  1. +85 −46 umpleonline/download_eclipse_umple_plugin.html
  2. +6 −7 umplewww/index.html
@@ -52,74 +52,46 @@ <h1> Downloading and installing <a href="http://www.umple.org">Umple</a></h1>
<p class="intro">
Below are instructions for downloading and installing Umple, a model-oriented programming technology that lets you model
in code. Here is <a href="http://umple.org">more information</a>
about Umple, or try it online without downloading, using the <a href="http://try.umple.org">UmpleOnline tool</a>
about Umple, or try it online without downloading, using the <a href="http://try.umple.org">UmpleOnline tool.</a>
</p>
<h2>A. Requirements to run Umple</h2>
<p class="intro">Umple can be used on Mac-OS, Windows or Linux. You have three downloading options described below: A) Command-line; B) Eclipse; C) Docker</p>
<p>Umple can be used on Mac-OS, Windows or Linux.</p>
<p class="intro">To obtain the full tree with source code <a href="https://github.com/umple/Umple">go to Umple's Github main page.</a> The list of <a href="https://github.com/umple/Umple/issues?utf8=&#10003;&q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc+"> recent changes can be found by clicking here</a></p>
<h3>For command-line use</h3>
<ul>
<li>An up-to-date Java 8 JVM (see instructions at the end of this page)
</ul>
&nbsp; <br/>
<h3>For Eclipse</h3>
<ul>
<li>Eclipse with Modelling tools.</li>
</ul>
&nbsp; <br/>
<h3>A. Downloading Umple for Command-Line use</h3>
<h2>B. Directions</h2>
<p><b>Requirement:</b> An up-to-date Java 8 JVM</p>
<h3>B.1 Downloading Umple (choose from the following options)</h3>
<p>Options:</p>
<ul>
<li><a class="button" href="https://github.com/umple/Umple/releases/latest/">
The latest official releases of Umple jars at GitHub</a><br/>&nbsp;<br/>
The command-line compiler and the Eclipse plugin are available, here along with release notes.<br />&nbsp;<br />
<li><a class="button" href="http://try.umple.org/scripts/umple.jar">The latest build of the command-line
compiler at the University of Ottawa</a><br/> &nbsp;<br/>
This is built after every commit from our continuous build process.
This is also the version of the compiler used by <a href="http://try.umple.org">UmpleOnline</a>. This version may contain experimental
features so should not be used in critical applications.<br />&nbsp;<br />
<li>To obtain the full tree with source code (including the Umple compiler as a jar, which is necessary to
compile Umple itself, select <a href="https://github.com/umple/Umple">go to the Github main page</a><br />
<li><b>Recent changes:</b> <a href="https://github.com/umple/Umple/issues?utf8=&#10003;&q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc+">The list of completed changes applied in the last six months can be found by clicking here</a>
</ul>
<br />&nbsp;<br />
This is built after every merge to master from our continuous build process, which can occur as frequently as every few hours, or as infrequently as every few weeks, depending on season. This version is thoroughly tested and will always contain the latest enhancements and fixes.
This is also the version of the compiler used by <a href="http://try.umple.org">UmpleOnline</a><br />&nbsp;<br />
<h3>B.2 Installing and running the Umple compiler in Eclipse</h3>
<p>Full directions for <a href="https://github.com/umple/umple/wiki/InstallEclipsePlugin">installing the Eclipse plugin can be found on this Umple Wiki Page.</a></p>
<br />&nbsp;<br />
<li><a class="button" href="https://github.com/umple/Umple/releases/latest/">
The latest official releases of the Umple command-line jar at GitHub, along with release notes</a><br/>&nbsp;<br/>
Use one of these releases if you need complete stability in the code generated from Umple. New releases are made 2-4 times a year.<br />&nbsp;<br />
</ul>
<h3>B.3 Running the Umple compiler on the command line</h3>
<p>To run the Umple compiler on the command line</p>
<ul>
<li>Run <pre>java -jar umple.jar &lt;options&gt; &lt;arguments&gt;</pre>
<li>Run <pre>java -jar umple.jar &lt;options&gt; &lt;files&gt;</pre>
<li>Specify your umple file as an argument.&nbsp;<br />
<li>Specify your umple file as an argument. The .ump suffix is normally used. One umple file can invoke another using the use statement. <br/>&nbsp;<br />
<li>You can use --help as an option to obtain the full set of command-line options. Options available include:
<ul>
<li>-g, --generate : Specify the output language: Java,RTCpp,
<li>-g, --generate <i>lang</i> : Specify the output language: Java,RTCpp,
Php,RTCpp,Ruby,SQL,Json,Ecore,TextUml,Scxml
Yuml,Cpp etc.
<li> --help : Display the help message
@@ -131,15 +103,82 @@ <h3>B.3 Running the Umple compiler on the command line</h3>
will be placed to path
<li> -v, --version : Print out the current Umple version
number
<li> -c - : Compile the generated code (i.e. go directly from Umple to an executable system)
</ul>
</ul>
<br />&nbsp;<br />
<h3>B. Installing and running the Umple compiler in Eclipse</h3>
<p><b>Requirements</b>: Java (as above), and the latest Eclipse with modeling tools.</p>
<p>Full directions for <a href="https://github.com/umple/umple/wiki/InstallEclipsePlugin">installing the Eclipse plugin can be found on this Umple Wiki Page.</a></p>
<br />&nbsp;<br />
<h3>C. Running UmpleOnline in your own computer's Docker installation</h3>
<p><b>Requirement</b>: <a href="https://www.docker.com/get-docker">Docker</a> installed on your computer.
<p>Umple provides a Docker image of Umpleonline that allows you to explore all the features of Umple through a web browser, with the server running locally on your computer. To use this, do the following after installing Docker. Detailed instructions can be found on <a href="https://hub.docker.com/r/umple/umpleonline/">Umple's Docker Hub page</a></p>
<ul>
<li>Pull the latest image (do this every time, so you get any changes):
<pre>
docker pull umple/umpleonline
</pre>
<li>In a terminal (console), invoke the image (you can change the 8000 to be another port both here and in the next instruction if you prefer):
<pre>
docker run --rm -ti -p 8000:80 umple/umpleonline >/dev/null
</pre>
<li>In a web browser, go to the following link: <a href="http://localhost:8000/umple.php">http://localhost:8000/umple.php</a><br/>&nbsp;<br/>
<li>IMPORTANT: Before quitting the image, download any Umple code you have written, as it is currently not persisted. You can do this from the running website by copy-and-paste, or by saving to Dropbox. Alternatively you can directly access the code in the running image, as beloe
<li>To quit the image: a) If started as above in Linux or Mac, hit control-c; or b) run 'docker ps' to find the name of the running image and kill it using 'docker kill image'.
</ul>
<p>To directly copy code in a running image to your host machine, do the following:</p>
<ul>
<li>Find out the name of your running image container:
<pre>
docker ps
</pre>
<li>Using this, find out the name of the directory where data is being stored:
<pre>
docker exec {container} ls -t var/www/ump/ | head -1
</pre>
<li>Now copy the data to somewhere, e.g. a directory called tmp
<pre>
docker cp {container}:/var/www/ump/{dirname} ~/tmp/fromDocker
</pre>
</ul>
<p>The Docker UmpleOnline option is not designed for large-scale projects; for those use the command-line (A) or Eclipse (B) downloads above. However, the Docker option can
<br />&nbsp;<br />
<h3>B.4 User Manual </h3>
<h3>User Manual </h3>
<p>Refer to the <a href="http://manual.umple.org">Umple user manual</a> for comprehensive help programming in Umple. The <a href="http://api.umple.org">API quick reference</a> and <a href="http://grammar.umple.org">grammar quick reference</a> may be of particular help for power users.</p>
View
@@ -65,8 +65,10 @@
<div class="level2"><b><a
href="http://manual.umple.org" >User Manual</a></b></div>
<div class="level2"><b><a href="https://hub.docker.com/r/umple/umpleonline/" >Docker site</a></b></div>
<div class="level2"><b><a href="http://code.umple.org" >Github
site</a></b></div>
site</a></b></div>
<div class="level2"><b><a href="http://wiki.umple.org"
>Wiki</a></b></div>
@@ -246,14 +248,11 @@ <h2>Model-Oriented Programming - Umple.org </h2>
can also
be used to create UML class and state diagrams textually.</p>
<p>Umple is an open source project, so details will evolve.
However,
it is ready to be used for real systems. In fact the Umple compiler
itself
is written in Umple. Any Java, C++ or PHP project could use Umple. We have
<p>Umple is an open source project that can be used for real systems in industry. In fact the Umple compiler itself
is written in Umple. Any Java, C++ or PHP project can be adapted to use Umple. We have
found the resulting code to be more readable and have many fewer lines.
This
is because Umple means you can avoid having to code a lot of
is because Umple means you can avoid having to write a lot of
'boilerplate'
code that would be needed to implement associations and attributes, a
system

0 comments on commit 37976df

Please sign in to comment.