BRL-CAD

Rewrite and simplify BRL-CAD's main INSTALL file

Every open source project includes introductory documentation like an INSTALL file that tells you how to install. BRL-CAD's INSTALL 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 INSTALL here:

There is also relevant installation information in:

Once you've read what's there, do a little homework to see how this is mixed up with these:

Then write a new INSTALL file 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 a new INSTALL file

Task tags

  • docs
  • writing
  • markdown
  • restructured text
  • text

Students who completed this task

Jeff Sieu

Task type

  • chrome_reader_mode Documentation / Training
close

2017