diff --git a/README.md b/README.md index b56a70f..0ede9df 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,57 @@ # drawingWithFriends -Live, collaborative drawing app + +> Live, collaborative drawing app + +## Team + + - __Product Owner__: Medhir + - __Scrum Master__: James + - __Development Team Members__: Dani, Liam + +## Table of Contents + +1. [Usage](#Usage) +1. [Requirements](#requirements) +1. [Development](#development) + 1. [Installing Dependencies](#installing-dependencies) + 1. [Tasks](#tasks) +1. [Team](#team) +1. [Contributing](#contributing) + +## Usage + +> Some usage instructions + +## Requirements + +Backend: + - Node 0.12.x + - Express 4 + - Bookshelf + - socket.io + - MySQL + +Frontend: + - Bower + - Backbone + - D3/SVG + - CSS grid (any if needed) + +## Development + +### Installing Dependencies + +From within the root directory: + +```sh +npm install (`npm install module --save` if adding new module) +bower install +``` + +### Roadmap + +View the project roadmap [here](https://waffle.io/lackadaisicalFoxtrot/drawingWithFriends) + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines. diff --git a/_README.md b/_README.md deleted file mode 100644 index 1083c1c..0000000 --- a/_README.md +++ /dev/null @@ -1,52 +0,0 @@ -# Project Name - -> Pithy project description - -## Team - - - __Product Owner__: teamMember - - __Scrum Master__: teamMember - - __Development Team Members__: teamMember, Liam Gallivan - -## Table of Contents - -1. [Usage](#Usage) -1. [Requirements](#requirements) -1. [Development](#development) - 1. [Installing Dependencies](#installing-dependencies) - 1. [Tasks](#tasks) -1. [Team](#team) -1. [Contributing](#contributing) - -## Usage - -> Some usage instructions - -## Requirements - -- Node 0.10.x -- Redis 2.6.x -- Postgresql 9.1.x -- etc -- etc - -## Development - -### Installing Dependencies - -From within the root directory: - -```sh -sudo npm install -g bower -npm install -bower install -``` - -### Roadmap - -View the project roadmap [here](LINK_TO_PROJECT_ISSUES) - - -## Contributing - -See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.