Permalink
Browse files

Updating Readme files in various directories

git-svn-id: http://umple.googlecode.com/svn/trunk@3083 6ebf9d09-8eb1-0036-9d08-68c07d1b990a
  • Loading branch information...
1 parent 90ca214 commit a9232ed7f01d531c81a76876c0eb84a392a4f592 @TimLethbridge TimLethbridge committed Oct 2, 2013
Showing with 67 additions and 11 deletions.
  1. +5 −0 ExternalTextEditorPlugins/ReadMe.txt
  2. +38 −7 ReadMe.txt
  3. +7 −4 cruise.umple/ReadMe.txt
  4. +17 −0 umpleonline/ReadMe.txt
@@ -0,0 +1,5 @@
+Directories for Umple plugins to various text editors
+
+The idea is that we should have plugins to essentially every popular text or model editor so people can use Umple natively in those environments. These should do syntax highlighting at the very least. Ideally they would add additional intelligence such context assist, interfacing to the compiler, etc.
+
+Consider contributing Umple-enabling plugins to other open source projects. If you do that, please add a link in this file.
View
@@ -1,4 +1,19 @@
-This is the main directory for various Umple subprojects
+This is the main directory for various Umple subprojects and components.
+
+Umple is a model-oriented programming technology. It allows developers to embed modelling concepts (e.g. associations, state machines), patterns and other abstractions in traditional code, and vice versa. It generates high quality code for Java, C++ and PhP (and can be embedded in or embed these), as well as diagrams, metrics and many other artifacts.
+
+Umple is developed in itself, guaranteeing robustness, hence the Umple compiler has to be distributed with the source (in the releases directory).
+
+Development follows a model-driven, test-driven, agile, continuous-integration process. Umple is hosted currently on Google Code at http://code.umple.org. It is mirrored on Github at https://github.com/umple/Umple Umple has been largely developed as a research project at the University of Ottawa, Canada, by numerous PhD and masters students, Many undergraduates from across Canada have also contributed. See the license file for the list of contributors.
+
+More details can be found as follows
+ * Umple home page: http://www.umple.org
+ * Umple user manual: http://manual.umple.org
+ * Download page: http://dl.umple.org
+ * Live diagram of the metamodel: http://metamodel.umple.org
+ * Architecture: http:/architecture.umple.org
+
+The items below are in alphabetical order.
Items marked *** are created by the build process only and are not version controlled.
They are referenced here so that people can better understand the hierarchy of files whether or not they have built the system.
@@ -16,12 +31,12 @@ They are referenced here so that people can better understand the hierarchy of f
cruise.umple.xtext.ui
Code for the Eciipse plugins
- examples
- Examples of Umple that the Umple team itself is managing
- externalexamples
- Products that use Umple that we have allowed to be managed here
- The idea is that they serve as extra tests
+ cruise.umple.nebula
+ New code generation infrastructure used for real-timeC++
+ dev-tools
+ Scripts and other tools used to help developers of Umple itself
+
dist ***
Main products to be distributed after a build
cruise.umple/reference - the user manual (needs also some umplewww pages)
@@ -32,6 +47,19 @@ They are referenced here so that people can better understand the hierarchy of f
umplesync.jar - used by UmpleOnline to synchronize graphical form
vml.jar - an extension for variability modeling
+ examples
+ Examples of Umple that the Umple team itself is managing
+ externalexamples
+ Products that use Umple that we have allowed to be managed here
+ The idea is that they serve as extra tests
+
+ ExternalTextEditrPlugins
+ plugins to text editing tools to allow them to do syntax highlighting with Umple or other more sophisticated Umple operations
+
+ jopt-simple
+ Fork of one of the very few packages (MIT-licensed) where we have borrowed code from others
+ See http://pholser.github.io/jopt-simple/
+
lib
Elements the Umple build depends on
@@ -47,7 +75,10 @@ They are referenced here so that people can better understand the hierarchy of f
UmpleToJava -> Code generation for Java
UmpleToPhp -> Code generation for Php
UmpleToRuby -> Code generation for Ruby
- UmpleTCpp -> Code generation for C++ - not yet ready / initialized with Java gen
+ UmpleToRTCpp -> Code generation for C++
+ UmpleTCpp -> Code generation for alternative C++ - not yet ready
+ UmpleToSDL -> Code generation to convert Umple to SDL
+ UmpleToSql -> Code generation SQL from Umple models
UmpleToTemplate -> Template for creating new code generation subprojects
umpleonline -> The UmpleOnline web application, which allows generation of code
@@ -4,6 +4,8 @@ Items marked *** are created by the build process only and are not version contr
They are referenced here so that people can better understand the hierarchy of files whether or not they have built the system. Never modify these files and never commit
them to version control.
+To learn more about key files in this directory, see http://architecture.umple.org
+
Items marked * are generated by the build process, but are version controlled as well. The reason for this is that we build Umple with itself, and we want to be able to always compile Umple with an earlier stable version of the compiler. Never modify any of these items.
Subdirectories:
@@ -16,20 +18,21 @@ Subdirectories:
Umple code for Umple plus some files in other formats such as .grammar
containing the grammar of Umple and .error containing descriptions of
various types of error messages to be generated.
- NOTE: Umple is designed to be written in itself. Add new files here
+ IMPORTANT: Umple is written in itself. Add new files here
and give them .ump suffices
Note that much functionality is split into two files
xx.ump - the model (independent of destination programming language)
- xx_ code.ump - methods written in Java for the model
+ xx_ code.ump - methods written in Java that accesses the model API
This is the most important directory in the system.
src-gen-jet
- * Code generated by Jet for the code generators
+ * Code generated by Jet for the code generators, copied here by build scripts
For the source used to generate these see ../UmpleTo*/templates/*.jet
+ Code here should never be manually modified.
src-gen-umple
- * Code generated by by Umple itself for Umple
+ * Code generated by by Umple itself for Umple. Never to be modified
src-uigu2
* Default code for the User Interface Generator for Umple, to be copied to
@@ -0,0 +1,17 @@
+Directory for the UmpleOnline web tool
+
+The public deployment of this can be found at http://try.umple.org
+
+Key files and directories *** means created at runtime
+
+ umple.php - main program of UmpleOnline
+ vml.php - main program of VML, an alternative tool for variability
+ simulate.php - code for the simulator (not recently maintained)
+ ump ***
+ *.ump and *.vml example files displayed by UmpleOnline
+ *** tmp* directories for each user session
+ *** numbered directories are created here for each saved user model
+ the date of the model is embeeded in the filename
+ scripts - PhP scripts for Umpleonline
+ download_eclipse_umple_plugin.html - main page of http://dl.umple.org
+ UmpleUpdateSite - website for automatic updating of Eclipse plugin

0 comments on commit a9232ed

Please sign in to comment.