Skip to content

README.md

Latest commit

 

History

History
177 lines (105 loc) · 5.75 KB

README.md

File metadata and controls

177 lines (105 loc) · 5.75 KB
Raw

SentientWell

The Sentient Well

Public Developement Repository

Application and amd tools source code for The Sentient Well public Sandbox can be found here.

Badges will go here

  • build status
  • issues (waffle.io maybe)
  • devDependencies
  • npm package
  • coverage
  • slack
  • downloads
  • gitter chat
  • license
  • etc.

Build Status Dependency Status Coverage Status Code Climate Github Issues Pending Pull-Requests Gem Version License Badges

INSERT ANOTHER GRAPHIC HERE

INSERT YOUR GRAPHIC HERE

  • Most people will glance at your README, maybe star it, and leave
  • Ergo, people should understand instantly what your project is about based on your repo

Tips

  • HAVE WHITE SPACE
  • MAKE IT PRETTY
  • GIFS ARE REALLY COOL

GIF Tools

  • Use Recordit to create quicks screencasts of your desktop and export them as GIFs.
  • For terminal sessions, there's ttystudio which also supports exporting GIFs.

Recordit

Recordit GIF

ttystudio

ttystudio GIF

Table of Contents (Optional)

If you're README has a lot of info, section headers might be nice.

Example of inline code linking (javascript)

// code away!

let generateProject = project => {
  let code = [];
  for (let js = 0; js < project.length; js++) {
    code.push(js);
  }
};
  • For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

Installation

  • All the code required to get started
  • Images of what it should look like

Clone

  • Instrucitons to clone this Repo to your sysem.

Setup

  • If you want more syntax highlighting, format your code like this:

Example of inline code linking (shell)

$ npm install
$ bower install
  • For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

Features

Usage (Optional)

Documentation (Optional)

Tests (Optional)

  • Going into more detail on code and technologies used
  • I utilized this nifty Markdown Cheatsheet for this sample README.

Contributing

To get started...

  • All neccessary installaiton and setup instrucitons/documents will be linked here as required.

Installation Instrucitons

How To Documents

Troubleshooting

Contributors/People

  • Contributors to projects and code will highlighted as required.

FAQ

  • Documents will be posted as required.

Support

Contact Options

License

License