Skip to content
Permalink
Browse files

Merge pull request #1518 from umple/ReadmeGithubStd

Making README file conform to standards [ci skip]
  • Loading branch information
TimLethbridge committed Nov 26, 2019
2 parents a6e1746 + 1ef1837 commit 5a97eca042d6cdedd546486211b84ad1a125ac00
Showing with 46 additions and 11 deletions.
  1. +46 −11 README.md
@@ -7,33 +7,68 @@ OS | Linux | OSX | Windows
**Status** | [![Travis-CI Build Status](https://travis-ci.org/umple/umple.svg?branch=master)](https://travis-ci.org/umple/umple) | [![Travis-CI Build Status](https://travis-ci.org/umple/umple.svg?branch=master)](https://travis-ci.org/umple/umple) | [![Windows Build status](https://ci.appveyor.com/api/projects/status/1yetvadynui7r8y6?svg=true)](https://ci.appveyor.com/project/vahdat-ab/umple/branch/master)


## Introduction
## Description

This is the main project for various Umple subprojects and components.

Umple is a model-oriented programming technology, allowing developers to embed modelling concepts (e.g. UML associations, state machines), patterns, generation templates, and other abstractions in traditional code, and vice versa. It generates high quality code for Java, C++ and PhP, as well as diagrams, metrics and many other artifacts. It can be embeded in the above languages as well as embed them.

The project homepage is located at http://umple.org/

## Development
Umple is developed in itself, guaranteeing robustness; the most recent version of the compiler must be used to compile itself. See the wiki for development setup.
There are a large number of scientific papers about Umple listed at: http://publications.umple.org

Development follows a model-driven, test-driven, agile, continuous-integration process. Umple is hosted currently on Github at http://code.umple.org. It was first released in 2007, and the master was on Google Code from 2011 to mid 2015.
## Development Process
Umple is developed in itself, guaranteeing robustness; the most recent version of the compiler must be used to compile itself. See the wiki for development setup: http://devsetup.umple.org

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 and the USA have also contributed through the UCOSP program. See the license file for the list of contributors.
Development follows a model-driven, test-driven, agile, continuous-integration process. Umple is hosted currently on Github at http://code.umple.org. It was first released in 2007. The master was on Google Code from 2011 to mid 2015 and moved to Github in 2015.

More details can be found as follows
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 and the USA have also contributed through the UCOSP program. See the license file for the list of contributors. http://license.umple.org

## Installation and Downloading

Umple does not need necessarily to be downloaded, the following allow you to run it directly in any web browser:

* UmpleOnline: http://try.umple.org - Website for the GUI version of Umple
* Docker: http://docker.umple.org - Install a docker image to run the GUI directly

You can download the java jar for command-line use, or the Eclipse plugin:

* Umple home page: http://www.umple.org - The master Umple page with a more comprehensive set of links
* Umple user manual: http://manual.umple.org - Full documentation of all Umple features
* UmpleOnline: http://try.umple.org - Website for the GUI version of Umple (can also be run on your local machine using Docker)
* Download page: http://dl.umple.org - Links to the latest official release and continuous builds (command-line, Eclipse, Docker)

To run locally on your machine, Umple needs Java (versions 8-13) installed. It runs on Mac, Linux and Windows.

## Usage

Umple is a programming and modeling language with a rich syntax. Full documentation with many examples can be found at

* Umple user manual: http://manual.umple.org

## Other Key links

* Umple home page: http://www.umple.org - The master Umple page with a more comprehensive set of links
* - Full documentation of all Umple features
* Live diagram of the metamodel: http://metamodel.umple.org
* Architecture: http://architecture.umple.org

Umple is continuously tested and built at the University of Ottawa using CruiseControl; see http://cc.umple.org . It is also built on Travis CI (http://travis.umple.org/) and Appveyor (https://appveyor.com/).

### Project setup

## Contributing

* Please report any bugs or improvement requests at: http://bugs.umple.org
* To set up your development environment please see: http://devsetup.umple.org
* For more details on contributing, please see: https://github.com/umple/umple/blob/master/CONTRIBUTING.md

## License

Umple is licensed under the MIT license. See http://license.umple.org

## Credits

All developers of Umple are listed in the license file at http://license.umple.org

Financial support has been received from NSERC and the Ontario Research Fund. IBM supported early development of Umple. Google and Facebook supported student travel during Umple's development.

## Contents of the directories

The umple project is split into many smaller subprojects; the folder hierarchy is explained below to better describe the structure.

0 comments on commit 5a97eca

Please sign in to comment.
You can’t perform that action at this time.