Skip to content

Commit

Permalink
Optimize README for ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacebrowning committed Aug 10, 2016
1 parent f73b584 commit 3f6ebb6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
**STATUS:** As of the 1.0 release, this project is no longer under active development. I still plan on accepting any passing pull requests to become part of future 2.x releases.
**STATUS:** As of the 1.0 release, this project is no longer under active development. Passing pull requests will be considered for future 1.x and 2.x releases.

-----

# Doorstop

[![Build Status](http://img.shields.io/travis/jacebrowning/doorstop/master.svg)](https://travis-ci.org/jacebrowning/doorstop)
[![Coverage Status](http://img.shields.io/coveralls/jacebrowning/doorstop/master.svg)](https://coveralls.io/r/jacebrowning/doorstop)
[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/jacebrowning/doorstop.svg)](https://scrutinizer-ci.com/g/jacebrowning/doorstop/?branch=master)
[![PyPI Version](http://img.shields.io/pypi/v/Doorstop.svg)](https://pypi.python.org/pypi/Doorstop)
[![PyPI Downloads](http://img.shields.io/pypi/dm/Doorstop.svg)](https://pypi.python.org/pypi/Doorstop)

# Overview

Doorstop manages the storage of textual requirements alongside source code in version control.

<img align="right" width="200" src="https://raw.githubusercontent.com/jacebrowning/doorstop/develop/docs/images/logo-black-white.png"/>
<img align="left" width="140" src="https://raw.githubusercontent.com/jacebrowning/doorstop/develop/docs/images/logo-black-white.png"/>

When a project utilizes this tool, each linkable item (requirement, test case, etc.) is stored as a YAML file in a designated directory. The items in each directory form a document. The relationship between documents forms a tree hierarchy. Doorstop provides mechanisms for modifying this tree, validating item traceability, and publishing documents in several formats.

Additional reading:
Expand All @@ -21,7 +22,7 @@ Additional reading:
- talks: [GRDevDay](https://speakerdeck.com/jacebrowning/doorstop-requirements-management-using-python-and-version-control), [BarCamp](https://speakerdeck.com/jacebrowning/strip-searched-a-rough-introduction-to-requirements-management)
- sample: [Generated HTML](http://jacebrowning.github.io/doorstop/index.html)

# Getting Started
# Setup

## Requirements

Expand All @@ -30,7 +31,7 @@ Additional reading:

## Installation

Doorstop can be installed with pip:
Install Doorstop with pip:

```
$ pip install doorstop
Expand Down Expand Up @@ -58,7 +59,7 @@ $ python
>>> doorstop.__version__
```

# Basic Usage
# Usage

Switch to an existing version control working directory, or create one:

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ pages:
- Graphical Interface: gui/coming-soon.md
- Scripting Interface: api/scripting.md
- About:
- 'Release Notes': about/changelog.md
- Release Notes: about/changelog.md
- Contributing: about/contributing.md
- License: about/license.md

0 comments on commit 3f6ebb6

Please sign in to comment.