Skip to content

Commit

Permalink
Add module template README.md files and update the base README file
Browse files Browse the repository at this point in the history
Fixes #248.
  • Loading branch information
joey-coleman committed Dec 23, 2013
1 parent 168fab8 commit bb9b84b
Show file tree
Hide file tree
Showing 48 changed files with 709 additions and 16 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# The Overture Tool

## General Information

If you'd like general information about the Overture Project, we suggest you have a look at http://overturetool.org.

## Development

Before you download and try to use the code provided in this open-source repository, please browse through the development wiki at https://github.com/overturetool/overture/wiki first!

This directory contains several subdirectories:

* The core Overture libraries are found in `code`, and are pure Java with no Eclipse dependencies
* The Overture IDE, based on Eclipse, are found in `ide`
* Documentation for VDM and Overture is in `documentation`
* Auxiliary code that supports the build process are found in `tools`



15 changes: 15 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Core Libries
- **Primary Contacts:**
Joey Coleman
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/ast/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Overture AST
- **Primary Contacts:**
Kenneth Lausdahl, Luis Couto
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/combinatorialtesting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Combinatorial Testing core library
- **Primary Contacts:**
Nick Battle, Kenneth Lausdahl
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/commandline/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Command-line interface
- **Primary Contacts:**
Kenneth Lausdahl, Joey Coleman
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/constraintsolverconn/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Constraint Solver Connection
- **Primary Contacts:**
Hiroshi Ishikawa
- **Status:**
Development

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/guibuilder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# GUI Builder
- **Primary Contacts:**
Kenneth Lausdahl
- **Status:**
Development

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/interpreter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# The VDM Interpreter (VDMJ-derived)
- **Primary Contacts:**
Nick Battle, Peter Jørgensen
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/modelcheckers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Connection to ProB
- **Primary Contacts:**
Kenneth Lausdahl
- **Status:**
Development

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/parser/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# VDM Parser
- **Primary Contacts:**
Nick Battle, Augusto Ribeiro
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/pog-string-based/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Proof Obligation Generator (String-based)
- **Primary Contacts:**
Nick Battle, Luis Couto
- **Status:**
Maintenance

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/pog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Proof Obligation Generator (AST-based)
- **Primary Contacts:**
Nick Battle, Luis Couto
- **Status:**
Development

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/prettyprinting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# VDM Pretty Printer
- **Primary Contacts:**
Augusto Ribeiro
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/testframework/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Testing Framework
- **Primary Contacts:**
Kenneth Lausdahl, Augusto Ribeiro
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/typechecker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# VDM Typechecker (VDMJ-derived)
- **Primary Contacts:**
Nick Battle, Peter Jørgensen
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/vdmj_compatibility_tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Compatibility tests between VDMJ and VDMTools
- **Primary Contacts:**
Kenneth Lausdahl, Augusto Ribeiro
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions core/vdmtools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# (Obsolete) Interface to VDMTools
- **Primary Contacts:**
Kenneth Lausdahl
- **Status:**
Obsolete

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# IDE (Eclipse) Libraries
- **Primary Contacts:**
Joey Coleman
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/build/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# (Obsolete) Old build setup
- **Primary Contacts:**
Joey Coleman
- **Status:**
Obsolete

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/builders/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Overture Builder Plugins
- **Primary Contacts:**
Joey Coleman
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/builders/vdmj/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# VDM Typechecker Eclipse Builder Plugin
- **Primary Contacts:**
Kenneth Lausdahl, Augusto Ribeiro
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Central Overture Eclipse Plugin
- **Primary Contacts:**
Kenneth Lausdahl, Augusto Ribeiro
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/debug/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# VDM Debugger/Interpreter Plugin
- **Primary Contacts:**
Kenneth Lausdahl, Augusto Ribeiro, Anders Kæls Malmos
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


15 changes: 15 additions & 0 deletions ide/features/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Eclipse Features for binding the plugins into the platform
- **Primary Contacts:**
Joey Coleman
- **Status:**
Production

## Description:


## Known Issues:


## Contributors:


Loading

0 comments on commit bb9b84b

Please sign in to comment.