Skip to content

Commit

Permalink
Minor updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinlaking committed Jul 30, 2015
1 parent c9f1fec commit b8d7076
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based
application framework without the need for Ncurses. I've tried to make Vedeu
as simple and flexible as possible.


## Requirements

Vedeu was been built primarily with Ruby v2.1; however, the
Expand All @@ -17,7 +16,7 @@ file will indicate the currently used Ruby version.
When Vedeu started I was a MacOSX user, I've since moved to Linux. You shouldn't
have any problems with either of these operating systems.

Note: You may have trouble running Vedeu with Windows installations. (Pull
**Note**: You may have trouble running Vedeu with Windows installations. (Pull
requests welcome!)


Expand All @@ -35,12 +34,15 @@ To use Vedeu's application scaffolding, see the
Have a look at: [Playa](https://github.com/gavinlaking/playa). Please browse the
source of Playa and Vedeu to get a feel for how it all works.

**Note**: Playa is based on an old version of Vedeu. Vedeu has significantly
improved since then and a better example is coming soon!

If you have produced software which uses Vedeu, please let me know, I'll link
to your project here.

## Documentation & Usage

Vedeu is largely documented using Yard. I hope to produce more 'General Usage'
Vedeu is documented using Yard. I hope to produce more 'General Usage'
documentation shortly. In the meantime, please browse the
[RubyDoc](http://rubydoc.info/gems/vedeu).

Expand Down Expand Up @@ -70,7 +72,6 @@ Any branch on the repository that is not `master` is probably experimental; do
into `master` before a release, and branches prefixed with `spike/` are me
playing with ideas.


### General contribution help

1. Fork it ([https://github.com/gavinlaking/vedeu/fork](https://github.com/gavinlaking/vedeu/fork))
Expand All @@ -83,7 +84,6 @@ Any branch on the repository that is not `master` is probably experimental; do
8. Push to the branch (`git push origin my-new-feature`)
9. Create a new pull request.


## Author & Contributors

### Author
Expand Down

0 comments on commit b8d7076

Please sign in to comment.