BRL-CAD (Org ID 5154791065911296)
Task ID 6236047245574144 | Task Definition ID 4759780591665152
Max instances: 5

Title: Rewrite and simplify BRL-CAD's main README file
Description: Every open source project includes introductory documentation like a README file to help you get started.  BRL-CAD's README file does the job, but it could be better.  Your task is to use your fresh perspective to take out what doesn't matter, add anything missing, and just make it all around better, more concise.  You can see the existing README here:
* http://svn.code.sf.net/p/brlcad/code/brlcad/trunk/README

There is also relevant information that README refers to here:
* http://svn.code.sf.net/p/brlcad/code/brlcad/trunk/doc/

Once you've read what's there, do a little homework to hear what other people say about writing a good readme:
* https://www.google.com/search?q=write+a+good+readme

Then write a new README for BRL-CAD.  It can stay plain text or change to a text-based format (e.g., markdown or restructured text) -- whatever is more appealing to you.  As this is a writing task, you will be expected to proofread for spelling, grammar, and structure mistakes.

SUBMIT the new README.
Tags: docs, writing, markdown, restructured text, text

Categories: Documentation & Training, Outreach & Research
Is Beginner: No
Time given to complete: 3 days

Mentors: brlcad@gmail.com, vasco.costa@gmail.com, indrplus@gmail.com, deeky.sharma@gmail.com
Student: Abdulazeez Abdulazeez (ID 5311350223929344)

Status: ABANDONED
Last modified: 2017-12-09 07:49:39