Documentation (wiki)

[brollb]

Created by: brollb

DeepForge's wiki/read the doc should include:

• Installation (for end user)
  • Prerequisites
  • Stable DeepForge release
  • Bleeding-edge version
  • Development installation
  • GPU support
  • Docker images
  • Heroku deployment (web UI)
• Tutorial (for end user)
  • Loading existing architecture
  • Creating new architectures
  • Creating/Downloading Caffe files
  • Training a classifier (MNIST example)
  • Testing for classification (MNIST example)
• Development (hacker's/Developer's guide)
  • npm run start-dev
  • project file structure
  • datamodel explanation
  • webgme-setup-tool
• DeepForge architecture notes (for developers)
  • relationship between server, worker, mongo and client
• contributing to DeepForge (for contributors)
  • make issues
  • feature branches (reference the issue!)
  • meaningful commits (and short!)
  • style guide
  • jshint
  • webgme-setup-tool

[brollb]

Created by: esube

I am creating readthedocs and moving all the documentations there for one-stop documentation place and link to it from the readme on the homepage of github.