Editing Deuces

From BRL-CAD

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
−
Below are tasks that are a great starting point for anyone interested in contributing to BRL-CAD. Most tasks can be completed in just a couple hours!  '''''No prior experience with BRL-CAD is required.''''' 
+
This is a list of succinct tasks that are expected to take most people familiar with the prerequisites less than two hours to complete.  It's a great starting point for anyone interested in contributing to BRL-CAD.
  
−
Some tasks may take longer if you aren't set up or haven't done that type before, but all they all require about the same amount of experienced effort.  Each task has a description, references, and list of files you'll probably need.  Can we make it any easier? [https://brlcad.zulipchat.com Let us know].
+
The tasks are all roughly the same complexity with '''''no prior BRL-CAD experience expected'''''.  A description is provided along with a list of references and files you'll probably need to edit.  Can we make it any easier?
  
−
= Get Set Up =
+
= Getting Started =
  
−
We suggest you [[Compiling|compile BRL-CAD]] yourself or, if you have trouble with that, there's a virtual image with everything preconfigured, ready to go:
+
Contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have questions, comments, or ideas of your own you'd like to suggest.
 +
 
 +
We've made an awesome virtual disk image that has everything you need preconfigured and ready to go:
  
 
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.]
 
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.]
 
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
 
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
−
# Import the disk image, start the VM, and log in (password is "Brlcad!" without quotes).
+
# Import and start the VM, log in (the password is "Brlcad!" without the quotes).
−
# Run "svn up brlcad-svn-trunk" and [[Compiling#Configure_your_Build|compile]].
+
# Run "svn up brlcad-svn-trunk" and get started!
  
−
= Pick a Task =
+
=Pick a Task=
  
−
Once set up, select any task that sounds interesting, read the references, and [https://brlcad.zulipchat.com talk with us] for help.  Don't worry if some words are confusing.  You got this.  All tasks can be completed by '''''anyone''''' but are grouped into the following five interest categories:
+
We break down all tasks into one of five categories.  Don't be worried if the tasks all sound confusing to you.  Just pick one and start reading the references we've provided.  Join IRC or our mailing list and ask questions.
  
−
* Code (programming)
+
# Code (programming)
−
* Documentation and Training (technical writing)
+
# Documentation and Training (writing)
−
* Outreach and Research (graphics, marketing)
+
# Outreach and Research (graphics)
−
* Quality Assurance (testing)
+
# Quality Assurance (testing)
−
* User Interface (usability, design)
+
# User Interface (designing)
  
 
__TOC__
 
__TOC__
  
 +
----
  
 
== Code ==
 
== Code ==
 +
----
 
''Tasks related to writing or refactoring code''
 
''Tasks related to writing or refactoring code''
  
 
See the When You're Done section above for details on submitting your changes.
 
See the When You're Done section above for details on submitting your changes.
  
 +
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Fix bounding box function for our polygonal mesh (BoT) primitive ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive.  Ideally, these boxes are as small as possible while still enclosing the primitive.  Currently the routine for BoTs is incorrect.  You can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing.  
−
| style="padding: 20px;" |
 
−
=== Close MGED only when both windows are closed ===
 
−
 
 
−
BRL-CAD has an interactive geometry editor called MGED.  It's often the starting point for beginners and allows creation and manipulation of models using commands.  When ''mged'' is run, it creates 2 windows:  a text console for commands and an interactive graphics window.  Currently, if you close the graphics window, it quits the application.
 
  
−
This task involves change behavior so that MGED exits only after closing ''both'' windows.  Closing just the graphics window or text console should not quit MGED.
+
This task involves studying the current code for the function rt_bot_bbox() and determining what is causing the current inaccuracies (the mged 'bb' command is a good way to visualize primitive bounding boxes).  Make changes to produce a more optimal bounding box.  Reimplement it from scratch if you like. The raytracing prep code in rt_bot_prep does prepare a better bounding box, so that is one place to check.
  
 
Code:
 
Code:
−
* src/mged/mged.c
+
* src/librt/primitives/bot/bot.c
−
* src/tclscripts/mged/openw.tcl
 
−
* src/tclscripts/mged/bindings.tcl
 
  
 +
|}
 
 
 
 
−
|}
 
 
 
 
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Close MGED when both windows are closed ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD has an interactive geometry editor called MGED.  It's often the starting point for beginners and allows creation and manipulation of models using commands.  When ''mged'' is run, it creates 2 windows: a text-console command window and an interactive graphics window.  When the user closes one of those windows, there is a bug.  Closing the graphics window closes the command window.
−
| style="padding: 20px;" |
 
−
=== Implement a primitive centroid function ===
 
  
−
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_'''ell'''_bbox() returns the bounding box dimensions for an '''ell'''ipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are more tricky to compute.
+
This task involves fixing this behavior so that ONLY closing ''both'' windows terminates the process properly and that closing either window does not take the other along with it.
  
−
This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point). There are numerous examples in our code where we compute centroids for other primitives.  The primitives that do not already have a centroid callback are itemized in following.
+
Code:
 +
* src/mged/mged.c
 +
* src/tclscripts/mged/openw.c
  
−
References:
+
|}
−
* http://en.wikipedia.org/wiki/Centroid
+
 
−
* http://mathworld.wolfram.com/
 
−
* include/raytrace.h: See ft_centroid callback defined in the rt_functab structure
 
  
−
Code:
 
−
* src/librt/primitives/table.c
 
−
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
  
−
 
 
 
|}
 
|}
 
 
 
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
=== Implement a primitive centroid function ===
−
| style="padding: 20px;" |
 
−
=== Implement a primitive curvature function ===
 
  
−
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones each described by a collection of callback functions, for example rt_'''sph'''_bbox() returns the bounding box dimensions for a '''sph'''ere.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
+
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
  
−
This task involves writing the callback function rt_xxx_curve() that computes the curvature at a given point on the surface of a primitive such as;
+
This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point).  There are numerous examples in our code where we compute centroids for other primtiives.  The primitives that do not already have a centroid callback are itemized in following.
−
* superell
 
−
* cline
 
−
* extrude
 
−
* grip
 
−
* metaball
 
−
* hrt.   
 
−
There are numerous examples in our code where we compute the curvature for other primitives like the ellipsoid, sphere, elliptical parabola, etc.
 
  
 
References:
 
References:
−
* http://en.wikipedia.org/wiki/Curvature
+
* http://en.wikipedia.org/wiki/Centroid
−
* http://en.wikipedia.org/wiki/Radius_of_curvature_(mathematics)
 
 
* http://mathworld.wolfram.com/
 
* http://mathworld.wolfram.com/
−
* include/raytrace.h: See the data structure that holds the curvature of a surface at a point (from Line 296) as well as the prototype for ft_curve() callback function defined in the rt_functab structure ( Line 2078).
+
* include/raytrace.h: See ft_centroid callback defined in the rt_functab structure
  
 
Code:
 
Code:
Line 94: Line 85:
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c
  
−
 
+
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... centroid function for extruded sketches (EXTRUDE) ====
 
|}
 
|}
 
 
 
 
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
| style="padding: 20px;" |
+
|
 +
 
 
=== Implement a primitive UV-mapping callback ===
 
=== Implement a primitive UV-mapping callback ===
  
−
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_'''ell'''_bbox() returns the bounding box dimensions for an '''ell'''ipsoid.  One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping.  An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
+
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping.  An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
  
 
This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback defined.  Note that this is an advanced task that might take you more than a couple hours if you don't have solid coding skills, but it's ultimately just a few lines of code.  See other primitives that already implement a UV-mapping callback for reference.
 
This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback defined.  Note that this is an advanced task that might take you more than a couple hours if you don't have solid coding skills, but it's ultimately just a few lines of code.  See other primitives that already implement a UV-mapping callback for reference.
Line 108: Line 103:
 
References:
 
References:
 
* http://en.wikipedia.org/wiki/UV_mapping
 
* http://en.wikipedia.org/wiki/UV_mapping
−
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, search for rt_*_uv() functions
+
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
 +
 
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... UV-mapping for extruded sketches (EXTRUDE) ====
  
 
Code:
 
Code:
Line 115: Line 114:
 
* include/rtgeom.h
 
* include/rtgeom.h
  
 +
|}
 
 
 
 
 +
 
|}
 
|}
 
 
 
 
 +
 
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Implement a platform independent re-entrant sort function ===
  
 +
The classic C library qsort() does not support a context parameter.  A work around is to store the context information in a static variable.  However, this solution is not thread save and may result in unpredictable behavior.
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
There are platform specific sort functions qsort_r() in incompatible versions for BSD and GNU and qsort_s() for MSVC.  Your task is to implement a bu_sort() function for BRL-CAD which is platform independent.
−
| style="padding: 20px;" |
 
−
=== Fix elliptical torus triangulation ===
 
−
 
 
−
BRL-CAD has many 3D object types, one of them being an "Elliptical Torus".  If you create a new MGED database and run this sequence of commands, it'll crash due to excessive recursion:
 
−
 
 
−
<pre>
 
−
make eto eto
 
−
tol norm 1
 
−
facetize eto.bot eto
 
−
</pre>
 
−
 
 
−
This task's goal is to reproduce, identify, and fix the bug so that detailed eto tessellation completes successfully.  To get started, see the rt_eto_tess() function in src/librt/primitives/eto/eto.c and the facetize command logic in libged.
 
  
 
Code:
 
Code:
−
* src/librt/primitives/eto/eto.c, <- you'll probably need to modify this file
+
* src/libbu/sort.c
−
* src/libged/facetize/facetize.cpp
 
  
−
&nbsp;
+
The new sort function could look like this:
 +
void bu_sort(genptr_t array, size_t nummemb, size_t sizememb, int (*compare)(const_genptr_t, const_genptr_t, genptr_t), genptr_t context);
 
|}
 
|}
 
&nbsp;
 
&nbsp;
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
----
−
| style="padding: 20px;" |
 
−
=== Implement a function that evaluates volume with spherical sampling ===
 
  
−
Implement this function:
+
== Documentation and Training ==
 +
----
 +
''Tasks related to creating/editing documents and helping others learn more about BRL-CAD''
  
−
    int estimate_volume(struct db_i *dbip,
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
                        struct directory *dp,
+
|
−
                        size_t min_samples,
+
=== Add missing documentation (for any ONE command) ===
−
                        double confidence);
 
  
−
For this function, you'll want to read up on some of BRL-CAD's basic data structures by looking at headers in the include/rt directory or by reading our [https://brlcad.org/docs/api/ API documentation].  Calling rt_db_internal() and rt_bound_internal() will get you the bounding box around geometry from which you can calculate a bounding sphere.  Once you have the bounding sphere, randomly generate a set of min_samples*2 points on the surface of the sphere.  Shoot a ray through those points using rt_shootray(), as in the ray tracing [[Example_Application|example]].  Keep track of a volume estimate and keep shooting sets of min_samples rays until the estimate is less than the specified confidence value.  Volume of a sphere is (4/3 * pi * r^3) so dividing that by num_samples will give a per-ray factor and multiplying all hit thicknesses by that factor will give a running volume estimate.
+
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
  
−
References:
+
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
−
* https://brlcad.org/docs/api/
 
−
* https://brlcad.org/wiki/Example_Application
 
−
* https://stackoverflow.com/questions/9600801/evenly-distributing-n-points-on-a-sphere
 
−
* https://karthikkaranth.me/blog/generating-random-points-in-a-sphere/
 
  
−
&nbsp;
+
This task involves writing basic documentation for '''JUST ONE''' of those commands in the Docbook XML format.  The command documentation should provide a one-sentence description, a detailed paragraph description (200+ words), explanation of '''all''' available command-line options, and one or more examples on how to use the command.
−
|}
 
−
&nbsp;
 
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Code:
−
| style="padding: 20px;" |
+
* doc/docbook/system/man1/en/Makefile.am
 +
* doc/docbook/system/man1/en/*.xml
  
−
=== Implement a function to return an object's color ===
+
|}
  
−
CAD geometry can have colors specified in a number of ways including directly on that object, in a parent object, and in a lookup table.  For this task, you're going to implement a function that reports the color of an object given a path to that object:
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write an article "BRL-CAD for dummies" ===
  
−
    int get_color(struct db_i *dbip, const char *path, struct bu_color *rgb);
+
Although BRL-CAD has extensive documentation, still it needs a short and simple document which is particularly built for dummies.
  
−
You'll need to iteratively consider each object named on the specified path (e.g., "/car/wheel/tire.r/torus") starting with "car" and working your down the path (i.e., 'wheel', 'tire.r', and then 'torus') to 1) see if a color is set on that object and 2) see if that color overrides lower-level colors (i.e., is inherited down the path), and 3) if it's a region object, whether there is a color set in the region table. You'll need to db_lookup() each object on the path to get access to its data.
+
This task involves writing a article named '''BRL-CAD for dummies'''. This article should start with the installation process, if there is any existing installation guide for dummies, provide a link to it. The main motive of this article to empower dummy to make his/her first model using BRL-CAD. One thing to be kept in mind while writing this article is that this article is mainly concentrated for dummies. So use simple language to an extent and if you need to mention some technical term, first explain that term.
  
−
For this function, you'll want to read up on some of BRL-CAD's basic data structures by looking at headers in the include/rt directory or by reading our [https://brlcad.org/docs/api/ API documentation].  This task may seem complicated if you're not familiar with C/C++ APIs, data structures, or hierarchical paths, so don't be shy [https://brlcad.zulipchat.com asking] questions.
+
The output of this task can be a pdf, html, doc, odt or any other document file that contains this article. Go through the link provided. Use screenshots and images to make it look attractive so that the reader is not bored.
  
−
References:
+
Reference:
−
* https://brlcad.org/docs/api/
+
* http://brlcad.org/wiki/Documentation
  
−
Code References:
+
|}
−
* src/libged/display_list.c
 
−
* src/libged/color/color.c
 
−
* src/librt/prep.c
 
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
 +
=== Create a book layout for Doc Camp Book ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD was selected to participate in the 2013 Google Summer of Code Doc Camp. A team of contributors got together in California, brainstormed, and wrote an entire book for BRL-CAD in just a few days. They created a guide for contributing to BRL-CAD.
−
| style="padding: 20px;" |
 
  
−
=== Stub in an OpenVDB object ===
+
In this task, you have to research the different styles Doc Camp book would need (i.e., code blocks, other blockquotes, special quotes for commands, for manpages, etc.) and everything around like a front page, the font, etc.
  
−
BRL-CAD has dozens of distinct primitive object types. For this task, you're going to implement the bare minimum to necessary to create a new object with the "make" command in MGED.
+
You can design some sample pages of Doc Camp book, that consists all the different types of article and provide with it's pdf. Also a separate document should be provided that contains information about the layout, which font is used and the size of font at different places.  
  
−
The best way to achieve this task is by searching for a keyword for another primitive (e.g., 'grep -r -i superell .') and implementing your new object the same way.  Start with the 'make' command itself in src/libged/make/make.c and add "vdb" alongside where you find one of the other primitive types (e.g., superell).  To get that to compile, you'll have to add new symbols you've defined into header files (e.g., include/rt/rtgeom.h).  You'll eventually need to implement barebones logic in src/librt/primitives/vdb too.
+
Reference:
−
 
+
* http://brlcad.org/wiki/Documentation
−
Code:
+
* [link to Doc Camp book]
−
* include/rt/defines.h <- needs an ID
+
|}
−
* include/rt/geom.h <- needs an "internal" i.e., in-memory structure
 
−
* src/libged/make/make.c <- needs to recognize "vdb" as a valid type
 
−
* src/librt/primitives/table.cpp <- needs an entry
 
−
* src/librt/primtiives/vdb <- needs a dir
 
−
* src/librt/primitives/vdb/vdb.c <- needs _import5/_export5 callbacks, maybe _describe too
 
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
 +
=== Fix errors in Hacking BRL-CAD book ===
  
−
== Documentation and Training ==
+
BRL-CAD was selected to participate in the 2013 Google Summer of Code Doc Camp. A team of contributors got together in California, brainstormed, and wrote an entire book for BRL-CAD in just a few days. They created a guide for contributing to BRL-CAD.
  
−
''Tasks related to creating/editing documents and helping others learn more about BRL-CAD''
+
The text of this guide was converted in DocBook XML format, from which other formats (HTML, PDF, man page, etc.) can be generated.  So there is an XML file to generate the Hacking BRL-CAD book.  But this file is missing all the structuring elements.
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
This task involves inserting all missing "chapter", "para" and "programlisting" tags into the XML file.
−
| style="padding: 20px;" |
 
−
=== Add missing documentation (for any ONE command) ===
 
  
−
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
+
References:
−
 
+
* http://brlcad.org/d/node/187
−
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
+
* doc/docbook/books/en/BRL-CAD_Tutorial_Series-*.xml
−
 
 
−
This task involves writing basic documentation for '''JUST ONE''' of those commands in the Docbook XML format.  The command documentation should provide a one-sentence description, a detailed paragraph description (200+ words), explanation of '''all''' available command-line options, and one or more examples on how to use the command.  
 
  
 
Code:
 
Code:
−
* doc/docbook/system/man1/en/Makefile.am
+
* doc/docbook/books/en/HACKING_BRL-CAD.xml
−
* doc/docbook/system/man1/en/*.xml
+
|}
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
 +
=== Write a step by step tutorial on modelling a toy car through BRL-CAD ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
This task involves writing a tutorial for modelling a car in BRL-CAD. This tutorial should be easy for a dummy to understand. Use screenshots and images for each step. The toy car model should be such that it can be printed using a 3d printer. As it's a toy car, make it look attractive and the one that is liked by children.
−
| style="padding: 20px;" |
 
−
=== Complete our "Intro to BRL-CAD Modeling" tutorial and extend it ===
 
  
−
We've developed two short and simple tutorials for introducing new users to modeling with BRL-CAD.
+
The output of this task can be a pdf, html, doc, odt or any other document file that contains this article. Go through the link provided. Don't forget to use screenshots and images as it will make it look attractive and the reader will not bored reading.
  
−
This task involves doing one of the tutorials (they take about an hour) and then extending it with a new section or making some other improvement.  At the end of the tutorial are several optional advanced "exercise left to the reader", for example.  Write a half-page step-by-step for one of the exercises left to the reader.  Include screenshots and images to make it look nice so the reader is not bored.
+
Go through existing tutorials to make your own.
  
 
Reference:
 
Reference:
−
* Come [https://brlcad.zulipchat.com talk with us] to make sure you get a copy of the latest version.
+
* http://brlcad.org/wiki/Documentation
−
* https://brlcad.org/w/images/9/90/Intro_to_BRL-CAD.pdf
+
* http://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf
−
* https://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf
+
|}
−
* ... there's another new one, but you have to ask for it ...
 
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
 +
=== Document MGED's 'saveview' command options ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's primary geometry editor (MGED) provides hundreds of commands.  Two of those commands are the savewview and loadview commands that write current view settings out to a text file and read them back in.  The saveview command provides -e -i -l and -o options, but they are not documented.
−
| style="padding: 20px;" |
 
  
−
=== Translate "Contributors Guide To BRL-CAD" To Any Language ===
+
This task involves writing documentation for those missing options.  Consult the source code to see what they do and add the corresponding sections into our Docbook XML doc just like we do in our other documentation files.  Test compilation to make sure your XML syntax is correct.
  
−
People interested in improving BRL-CAD sometimes find themselves lost in a sea of information. In all, BRL-CAD has more than a million words of documentation across hundreds of manual pages, dozens of tutorials and examples, hundreds of wiki pages, dozens of technical papers, and other resources. There are literally thousands of features and this can sometimes pose problems.
+
References:
 +
* src/libged/saveview.c
 +
* doc/docbook/system/mann/en/*.xml
  
−
In 2013, a team of contributors got to California and worked on an entire book titled "Contributors Guide To BRL-CAD" in just a few days. This great resource needs to be translated to other languages to attract developers from other lingual backgrounds (who don't read English ) to contribute to BRL-CAD.
+
Code:
 +
* doc/docbook/system/mann/en/saveview.xml
  
−
This task involves translating the chapters/sections of the "Contributors Guide To BRL-CAD" into a language of your choice such as Mandarin, French, Chinese, Spanish, German, Hindi, Arabic, Russian, etc. Chapters/Sections include
+
|}
  
−
* Feature Overview
 
−
* Working with our Code
 
−
* What code to work on
 
−
* How to contribute
 
−
* .... (Just to name a few )
 
−
 
−
The output of this task can be a pdf, html, doc, odt or any other document file that contains the translated article.Images in the original document (see link in Reference below) should not be changed ! only text should be.
 
−
 
−
Reference:
 
−
* http://en.flossmanuals.net/_booki/contributors-guide-to-brl-cad/contributors-guide-to-brl-cad.pdf
 
−
 
−
&nbsp;
 
−
|}
 
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
−
 
 
 
=== Write a "BRL-CAD Commands Quick Reference" document ===
 
=== Write a "BRL-CAD Commands Quick Reference" document ===
  
Line 291: Line 257:
 
* http://brlcad.org/wiki/Documentation
 
* http://brlcad.org/wiki/Documentation
 
* http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf
 
* http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf
−
* [http://appletree.or.kr/quick_reference_cards/CVS-Subversion-Git/git-cheat-sheet-large.png git example]
+
* http://appletree.or.kr/quick_reference_cards/CVS-Subversion-Git/git-cheat-sheet-large.png
−
* [http://www.stdout.org/~winston/latex/latexsheet-0.png latex example]
+
* http://www.stdout.org/~winston/latex/latexsheet-0.png
−
* [http://img.docstoccdn.com/thumb/orig/524314.png another example]
+
* http://img.docstoccdn.com/thumb/orig/524314.png
−
* [http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png drupal example]
+
* http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png
−
* [http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg php example]
+
* http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
−
 
 
 
=== Doxygen cleanup ===
 
=== Doxygen cleanup ===
  
Line 315: Line 278:
 
* http://www.stack.nl/~dimitri/doxygen/
 
* http://www.stack.nl/~dimitri/doxygen/
  
−
&nbsp;
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
−
 
+
|
−
{| style="background-color:#efefef; border-style: solid; border-width: 2px;" width="100%"
 
−
| style="padding: 10px;" |
 
 
==== ... doxygen cleanup for LIBBU ====
 
==== ... doxygen cleanup for LIBBU ====
  
Line 328: Line 289:
 
* misc/Doxyfile
 
* misc/Doxyfile
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#efefef; border-style: solid; border-width: 2px;" width="100%"
+
|
−
| style="padding: 10px;" |
 
 
==== ... doxygen cleanup for LIBWDB ====
 
==== ... doxygen cleanup for LIBWDB ====
  
Line 344: Line 304:
 
* misc/Doxyfile
 
* misc/Doxyfile
  
−
&nbsp;
 
 
|}
 
|}
 
&nbsp;
 
&nbsp;
−
 
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#efefef; border-style: solid; border-width: 2px;" width="100%"
+
|
−
| style="padding: 10px;" |
 
 
==== ... doxygen cleanup for LIBRT ====
 
==== ... doxygen cleanup for LIBRT ====
  
Line 361: Line 319:
 
* src/librt/binunif
 
* src/librt/binunif
 
* misc/Doxyfile
 
* misc/Doxyfile
 +
|}
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write a manual page for MGED's "brep" command ===
 +
 +
BRL-CAD's MGED geometry editor provides hundreds of commands.  One of those commands for manipulating and visualizing geometry is the "brep" command.
 +
 +
This task involves writing a manual page for that command in the Docbook XML format.  There are lots of examples to follow.
 +
 +
References:
 +
* doc/docbook/system/mann/en/*.xml
 +
* http://brlcad.org/wiki/Documentation (contains intro to mged and cheat sheets)
 +
* bin/mged  (you'll need to run this to use the "brep" command)
 +
* bin/csgbrep  (will create a slew of 'brep'/nurbs objects for the "brep" command)
 +
 +
Code:
 +
 +
* doc/docbook/system/mann/en/brep.xml  (you write this)
 +
* doc/docbook/system/mann/en/CMakeLists.txt  (you edit this)
 +
 +
Running "make" in a build directory will compile your documentation into html and man page format so you can validate the syntax and formatting.  See [[Compiling]] for help.
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write up Wiki page tutorial on our Volumetric Primitive ===
 +
 +
BRL-CAD provides a couple dozen distinct primitives.  Each primitive is defined by a set of parameters.  Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.
 +
 +
This task involves writing up a page on the VOL primitive.  Figure out how to use it (see the "in" command), create an example input data set, and write up a wiki page on exactly what steps are needed similar to our other wiki pages:
 +
 +
References:
 +
* http://brlcad.org/wiki/DSP
 +
* http://brlcad.org/wiki/Sketch
 +
* http://brlcad.org/wiki/EBM  <-- particularly useful as the data is similar for VOL
 +
 +
Show how to create a VOL with at least two layers/slices.  Include images like the other examples.  Put the write-up at http://brlcad.org/wiki/VOL
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
=== Write a wiki tutorial on how to create a polygonal mesh (NMG) manually ===
−
=== Add images to our wiki page on Volumetric objects ===
 
  
 
BRL-CAD provides a couple dozen distinct primitives.  Each primitive is defined by a set of parameters.  Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.
 
BRL-CAD provides a couple dozen distinct primitives.  Each primitive is defined by a set of parameters.  Several of the more complex primitives have a wiki page describing them in more detail with an example on how to create them.
  
−
This task involves adding images to our page for the VOL primitive.  You'll need to first complete the tutorial and save images for each step.  Add the images to the wiki page.
+
This task involves writing up a page on the NMG polygonal mesh primitive.  Figure out how to use it (not a simple task, will require some trial and error), create an example input, and write up a wiki page on exactly what steps are needed similar to our other wiki pages:
  
 
References:
 
References:
−
* http://brlcad.org/wiki/VOL
 
 
* http://brlcad.org/wiki/DSP
 
* http://brlcad.org/wiki/DSP
−
* http://brlcad.org/wiki/Sketch
 
 
* http://brlcad.org/wiki/EBM
 
* http://brlcad.org/wiki/EBM
 +
* http://brlcad.org/wiki/Sketch <-- particularly useful as neither NMG nor sketch are meant to be created manually
 +
 +
Note the "facetize" command in mged will convert an existing object into NMG format.  The get/put commands should help from there like the sketch tutorial.
 +
 +
Show how to create an NMG cube or wedge or similar simple shape.  Include images like the other examples.  Put the write-up at http://brlcad.org/wiki/NMG
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
 
=== Fix Image Formatting in BRL-CAD's DocBook Documentation (any ONE large document or 4 smaller documents) ===
 
=== Fix Image Formatting in BRL-CAD's DocBook Documentation (any ONE large document or 4 smaller documents) ===
  
Line 436: Line 433:
 
Code:
 
Code:
 
* doc/docbook
 
* doc/docbook
 +
 +
|}
 +
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Transcribe a COM-GEOM Geometry Model from a PDF report to an ASCII file ===
 +
 +
We have scans of a number of reports documenting early geometric models from the analysis system that preceeded BRL-CAD.  These reports often contain the actual geometry defining the model as pages and pages of numbers, but the quality is sufficiently poor that optical character recognition is not reliable.
 +
 +
This task is to attempt the manual transcription of the MEP-021A Generator Set model described in the report "A Combinatorial Geometry Computer Description of the MEP-021A Generator Set" (see the References list below for the link that will let you download the PDF).  One possible approach is to use Acrobat Reader or some other PDF reader select and copy the OCR text, paste that to a text file as a starting point, and then manually correct it.  There may also be some patterns that will allow for semi-automated processing (for example, if 5 zeros in a row are commonly replaced with the character "O" instead of 0, a search and replace is in order.)  However you wish to approach it is fine, but remember that the goal is not just the extraction of the OCR text but the production of an accurate transcription of the file.  The OCR text can be used as a starting point but is not likely to be accurate.
 +
 +
At the end of the day, the goal is to have a file that can be fed to BRL-CAD's comgeom-g importer to generate an accurate .g file.  If the generator conversion goes well, there are a significant number of other models (some of them considerably more complex) that we are interested in that can be used to create more tasks of this nature.
 +
 +
References:
 +
* http://www.dtic.mil/docs/citations/ADA073408
 +
 +
Code:
 +
* src/conv/comgeom
 +
 +
|}
 +
 +
 +
----
 +
 +
==Outreach and Research ==
 +
----
 +
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
 +
=== Investigate permuted vertex lists from g-iges + iges-g ===
 +
 +
BRL-CAD has a geometry exporter and importer for the International Graphics Exchange Standard (IGES) file format.  If you run our g-iges exporter on some geometry, then run iges-g on that same geometry to import it back to BRL-CAD format, the geometry will have permuted vertex lists.  Particularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not.
 +
 +
This task involves investigating why this occurs, reporting (in detail) why it occurs, and if obvious, making a recommendation on how to fix the problem.
 +
 +
Code:
 +
* src/conv/iges
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
 +
=== Create a high quality png of BRL-CAD logo ===
 +
 +
This task involves re-designing BRL-CAD logo and providing with a high quality png that has transparent background. Check out the following link to get a basic idea about logo.
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
Logo Refernces:
−
| style="padding: 20px;" |
+
* http://brlcad.org/images/angelov_256.png
−
=== Find 5 bugs in OGV ===
+
* http://brlcad.org/d/node/92
  
−
Online Geometry Viewer is a web based application with which you can see 3D .g models in browser without the use of any plugins. Your task will be to deploy OGV locally and find 5 bugs or errors in it.
+
|}
  
−
Links:
 
−
https://github.com/BRL-CAD/OGV-meteor/
 
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write article on BRL-CAD's code hardening efforts ===
 +
 +
We've been working for several years on "code hardening", improving the quality of BRL-CAD's source code through a variety of best practices and code cleanup efforts.
 +
 +
This task has you write an article that succinctly summarizes all of our efforts.  You'll need to become familiar with our HACKING file as well as read up on our various hardening efforts. You're welcome to ask our devs questions over IRC for more information too.
 +
 +
Include at least one picture.  Article should be 300-900 words long and be fully proof-read before submitting (check for grammar and spelling mistakes, please).
 +
 +
Resources:
 +
* http://brlcad.org/wiki/Code_Cleanup
 +
* http://brlcad.org/d/node/96
 +
* http://www.coverity.com/library/pdf/coverity-scan-2011-open-source-integrity-report.pdf
 +
 +
Add the article to http://brlcad.org/wiki/Community_Publication_Portal
 +
 +
|}
 +
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Write an article soliciting a Windows platform maintainer ===
 +
 +
BRL-CAD runs on a number of platforms and distributes releases many times a year.  Creating a release for any particular binary platform, like Windows or Mac OS X or Linux, is delegated to a "release maintainer".  We currently have maintainers for a number of platforms but do not have one for Windows.  Basically, it's a volunteer job, it's a lot of work, but not very hard and very rewarding.  There are thousands of binary downloads every month, so lots of people benefit from a maintainer's efforts. 
 +
 +
This task involves writing a brief solicitation article announcing our interest for a maintainer, describing the responsibilities involved, and telling them how to take up this responsibility.  Come talk to us on IRC for more specific details.
 +
 +
Resources:
 +
* http://svn.code.sf.net/p/brlcad/code/brlcad/trunk/HACKING
 +
(See the release section near the bottom to see what maintainers do)
 +
 +
Add the article to http://brlcad.org/wiki/Community_Publication_Portal
 +
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create an ISST screenshot or animation ===
 +
 +
Everyone loves to see screenshots and animations of software in action. We use both in our marketing and outreach. See some of the examples below that we already have.
 +
 +
Create an awesome screenshot and/or animation of our 'isst' tool in action. It's an interactive geometry viewer interface.  It should be graphically interesting and give some sense of capability.  You should import a visually complex and interesting model with LOTS of polygons and detail.
 +
 +
References:
 +
* http://brlcad.org/gallery/d/19-4/MGED.jpg
 +
* http://brlcad.org/tmp/archer.png
 +
* http://brlcad.org/gallery/s/screenshots/
 +
* http://www.google-melange.com/gci/task/view/google/gci2012/8019211
 +
 +
Note that we have several screenshot tasks.  Note you may have to go through some or our basic MGED tutorials (see docs section on our website) just to be able to display geometry.  Finally, give others a chance if you already completed one of the other screenshot tasks. ;)
 +
|}
 +
 +
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Generate a code coverage report (lcov+gcov) ===
 +
 +
This task involves setting up and generating an lcov code coverage analysis on BRL-CAD.  After learning how to use the tool, discuss with the developers what portion of the code will be most useful to analyze, or scan these:
 +
 +
"benchmark"
 +
"make test"
 +
"make regress"
 +
Submit the results.
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Model BRL-CAD logo in BRL-CAD ===
 +
 +
The BRL-CAD Logo depicts two interlocked nodes. Modeling the new Logo in BRL-CAD in CSG (without NURBS, without polygons) requires some careful arrangement, but can provide an attractive three dimensional rendering that we can use for a number of purposes..
 +
 +
The output of this task will be a .g file of BRL-CAD logo and a rendered image. The two segments you model MUST be two or more regions, ideally hinged together (you can have center pins or not, you decide).  This is your opportunity as an artist and 3D magician to come up with an interesting yet faithful interpretation.
 +
 +
References:
 +
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 +
 +
Note that there are other logo modeling tasks and yours must start from scratch and be completely original. If we get a hint that yours was based off of or used measurements from some other model, you will be barred.
  
−
==Outreach and Research ==
+
|}
−
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
 
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
&nbsp;
−
| style="padding: 20px;" |
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 
=== Profile NURBS prep performance ===
 
=== Profile NURBS prep performance ===
  
Line 472: Line 597:
  
 
Running "rt -o file.png -s32" on the system command line (not inside mged) should minimize the ray overhead or you can specifically isolate the prep phase we care about.  Prep is the time between when rt is run where it opens a window until the first pixels are fired and pixels start filling in.
 
Running "rt -o file.png -s32" on the system command line (not inside mged) should minimize the ray overhead or you can specifically isolate the prep phase we care about.  Prep is the time between when rt is run where it opens a window until the first pixels are fired and pixels start filling in.
 +
|}
  
 
&nbsp;
 
&nbsp;
−
|}
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
&nbsp;
+
|
−
 
 
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
 
=== Continue investigating GMP integration ===
 
=== Continue investigating GMP integration ===
  
Line 489: Line 612:
 
Building on the previous GCI task work, take it to the next step.  Try setting a vector to 1/3, 1/3, 1/3 and 0.1, 0.1, 0.1 and get proper values to print.  Change the V3ARGS() macro if needed.  If that all works, try to get bn_dist_pt3_pt3() to work.  Report and discuss your progress.
 
Building on the previous GCI task work, take it to the next step.  Try setting a vector to 1/3, 1/3, 1/3 and 0.1, 0.1, 0.1 and get proper values to print.  Change the V3ARGS() macro if needed.  If that all works, try to get bn_dist_pt3_pt3() to work.  Report and discuss your progress.
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create prototype 2D Drawing ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD provides limited services for drafting features including the production of 2D CAD drawings (blueprints).
−
| style="padding: 20px;" |
 
−
=== Upgrade OpenNURBS, report issues ===
 
  
−
BRL-CAD uses a customized OpenNURBS library for advanced geometry but it's out of date.  For this task, you're going to download the latest OpenNURBS code and upgrade the sources we bundle.  The easiest way is probably to move src/other/openNURBS to src/other/openNURBS.backup, and then put the latest OpenNURBS release into src/other/openNURBS.
+
This task involves designing a 2D CAD drawing prototype.  The prototype MUST capture a set of design requirements and follows industry conventions.
  
−
Once that's done, you'll need to add the src/other/openNURBS.backup/CMakeLists.txt file and make sure the list of files it has matches the files in src/other/openNURBS.  Last but not least, re-run cmake and make sure it compiles. You may need to consult the newer openNURBS makefile to see if there are other edits needed in the CMakeLists.txt file.
+
If you've never seen a real blueprint drawing before, then this task might be too hard for you.  Your result needs to refer to ISO 128 and/or ASME Y14.41 or other standard drawing elements.  
  
−
Save output from any commands you run because you'll probably encounter an error, and that's okay.  Just submit logs of all output so we can figure out next steps.
+
Basically, identifying a style of drawing that we should support including pointing out the critical elements to be included on each drawing, their location, size, placement, etc.
  
 
References:
 
References:
−
* https://github.com/mcneel/opennurbs
+
* http://brlcad.org/design/drafting
 +
* http://en.wikipedia.org/wiki/ISO_128
 +
* http://en.wikipedia.org/wiki/ASME_Y14.41-2003
 +
* http://en.wikipedia.org/wiki/Geometric_Dimensioning_and_Tolerancing
 +
* http://www.ptc.com/WCMS/files/45691/en/4307_FoundationXE_DS.pdf
 +
 
 +
Note that this is a "redo" of a previous GCI task.  Read the discussion thread and his work to help ensure you don't make similar mistakes. ;-)
 +
 
 +
http://www.google-melange.com/gci/task/view/google/gci2012/7985229
  
−
Code:
+
|}
−
* src/other/openNURBS <- replace existing with latest openNURBS from github
 
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Model a toy car with wheels and axles in BRL-CAD ===
 +
 +
This task involves modeling a toy car in BRL-CAD. The toy car should be modeled in such a way that it can be printed using a 3d printer. The shape of toy car should be thought by keeping the word TOY in mind. As this shape would be 3d printed, all the axle and wheel arrangement should be done.
 +
 +
The output of this task would be a rendered image, and .g file of the toy car. If you wish to write a step by step tutorial of creating this model, search for it as another GCI task is there to write a tutorial.
 +
 +
References
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
 
=== Design a T-Shirt for BRL-CAD ===
 
=== Design a T-Shirt for BRL-CAD ===
  
Line 520: Line 661:
  
 
Logo References
 
Logo References
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
 
=== Design a coffee mug for BRL-CAD ===
 
=== Design a coffee mug for BRL-CAD ===
  
−
This task involves designing a coffee mug for BRL-CAD. Make it look good or at least interesting, and make it in BRL-CAD. Look over some coffee mug designs before starting to work on this. Verify that your mug is valid geometry by running the "rtcheck" command.  
+
This task involves designing a coffee mug for BRL-CAD. Make it look good, so that one can use it while working on BRL-CAD. Look over some great coffee mug designs before starting to work on this. It would be great if the design on coffee mug has some special meaning.
  
 
Logo References
 
Logo References
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
 
=== Design BRL-CAD sticker ===
 
=== Design BRL-CAD sticker ===
  
Line 546: Line 687:
  
 
Logo References
 
Logo References
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
 +
 
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design BRL-CAD phone/tablet back cover ===
 +
 +
This task involves designing a BRL-CAD phone/tablet cover.
 +
While submitting your design, provide the sample phone cover, tablet cover with the design and rendered png or jpg image of the sticker design. Try to have a special meaning of design, and the concept should be creatively illustrated.
 +
 +
Logo References
 +
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a wallpaper set for BRL-CAD ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
This task involves designing a set of wallpapers for BRL-CAD. The central idea of each wallpaper should represent any feature of BRL-CAD. Try to design a minimum of 5 wallpapers but if you have more than 5 designs than you are welcomed.  
−
| style="padding: 20px;" |
 
−
=== Design a wallpaper / desktop image for BRL-CAD ===
 
−
 
 
−
This task involves designing a desktop background for BRL-CAD enthusiasts. The main idea of your wallpaper should be to showcase one or more features of BRL-CAD. Be intentional and able to defend/describe your choice of color, layout, and other aspects of the wallpaper design.
 
 
   
 
   
−
Try to make sure the wallpaper works across a broad selection of screen resolutions.
+
Try to different resolutions of each wallpaper.
  
−
Search the web for wallpapers inspiration such as:
+
Check the following wallpapers for inspiration.
 
* http://www.smashingmagazine.com/tag/wallpapers/
 
* http://www.smashingmagazine.com/tag/wallpapers/
  
 
Logo References
 
Logo References
−
* [https://brlcad.org/img/logo_color.png BRL-CAD Logo]
+
* http://brlcad.org/images/angelov_256.png
 +
* http://brlcad.org/d/node/92
  
−
&nbsp;
 
 
|}
 
|}
 +
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create Iron Man Arc Reactor Model in BRL-CAD ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
This task involves creating Arc Reactor as seen in hollywood movie Iron-Man. You will have to create two versions of the Arc Reactor one glowing and another non glowing.
−
| style="padding: 20px;" |
+
−
=== Model a Lightcycle in BRL-CAD using CSG ===
+
Check this model for inspiration
 +
* http://grabcad.com/library/iron-man-arc-reactor-request
  
−
The movie Tron is an iconic computer graphics film that used CSG primitives for a majority of the movie's 3D virtual world.  The film is famous for "lightcycle" vehicles that were allegedly modeled using 57 primitives and/or Boolean operations.  For this task, see if you can recreate the masterpiece in BRL-CAD.
 
−
 
−
See this lightcycle discussion thread
 
−
* http://www.tron-sector.com/forums/default.aspx?a=top&id=336281
 
  
−
&nbsp;
 
 
|}
 
|}
−
&nbsp;
+
 
 +
 
 +
----
  
 
== Quality Assurance ==
 
== Quality Assurance ==
 +
----
 
''Tasks related to testing and ensuring code is of high quality''
 
''Tasks related to testing and ensuring code is of high quality''
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
| style="padding: 20px;" |
+
|
 
=== Fix single-precision floating point crash ===
 
=== Fix single-precision floating point crash ===
  
Line 620: Line 779:
 
* src/liboptical/sh_light.c
 
* src/liboptical/sh_light.c
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
 
 
=== Fix closedb ===
 
=== Fix closedb ===
  
Line 644: Line 802:
 
* src/mged/mged.c
 
* src/mged/mged.c
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
=== Create an utility library (LIBBU) API unit test ===
−
=== Create a utility library (LIBBU) API unit test ===
 
  
 
There are more than 300 library functions in our core LIBBU library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
 
There are more than 300 library functions in our core LIBBU library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
  
−
This task involves implementing new unit tests for any of LIBBU's source files that do not already have a unit test defined.  The test should run all of the public functions and be hooked into our build system.  We have lots of existing unit tests to follow as examples.
+
This task involves implementing a new unit test for any of LIBBU's source files that do not already have a unit test defined.  The test should run all of the public functions and be hooked into our build system.  We have lots of existing unit tests to follow as an example.
  
 
References:
 
References:
Line 665: Line 822:
 
* src/libbu/tests/CMakeLists.txt
 
* src/libbu/tests/CMakeLists.txt
  
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBU badmagic.c ====
 +
|}
 
&nbsp;
 
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBU bomb.c ====
 
|}
 
|}
 +
|}
 +
 
&nbsp;
 
&nbsp;
−
 
+
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|
−
| style="padding: 20px;" |
+
=== Create numerics library (LIBBN) API unit test ===
−
 
 
−
=== Create Numerics library (LIBBN) API unit tests ===
 
  
 
There are more than 300 library functions in our core LIBBN library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
 
There are more than 300 library functions in our core LIBBN library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
  
−
This task involves implementing new unit tests for any of LIBBN's source files that do not already have a unit test defined.  The test should run all of the public functions and be hooked into our build system.  We have lots of existing unit tests to follow as examples.
+
This task involves implementing a new unit test for any of LIBBN's source files that do not already have a unit test defined.  The test should run all of the public functions and be hooked into our build system.  We have lots of existing unit tests to follow as an example.
  
 
References:
 
References:
Line 683: Line 847:
 
* include/vmath.h
 
* include/vmath.h
 
* src/libbn/*.c
 
* src/libbn/*.c
−
* src/libbn/tests/*.c <-- check this directory for examples
+
* src/libbu/tests/*.c <-- note libbu, not libbn for examples
−
* src/libbu/tests/*.c <-- Note: Also check this too for more examples.
 
  
 
Code:
 
Code:
Line 690: Line 853:
 
* src/libbn/tests/CMakeLists.txt
 
* src/libbn/tests/CMakeLists.txt
  
−
<b> Note </b>
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
−
A valid task will constitute writing a basic test for each function in the following libbn/ files.
+
|
 +
==== ... unit test for LIBBN axis.c ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBN qmath.c ====
 +
|}
 +
&nbsp;
 +
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
==== ... unit test for LIBBN rand.c ====
 +
|}
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Find, reliably reproduce, and report any bug in Archer ===
 +
 +
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
 +
 +
This task involves filing a bug report with verifiable and reproducible steps that clearly demonstrate the bug.  It can't be a bug already reported or otherwise documented nor can it be merely behavior you don't like.
 +
 +
References:
 +
* archer
 +
* Introduction to MGED at http://brlcad.org/wiki/Documentation (many of the mged commands are available in some fashion within archer)
 +
* BUGS file in any source/binary distribution
 +
* http://sourceforge.net/tracker/?atid=640802&group_id=105292&func=browse
 +
|}
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN anim.c ====
 
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Reproduce any 10 unconfirmed open bug reports ===
 +
 +
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned.  Read the comments and status to see if the bug has been confirmed/reproduced. 
 +
 +
This task involves going through those reports and REPRODUCE at least 10 of the ones that have not been confirmed.  When you can reproduce the issue being reported, you'll comment on the thread to state as much and attach any data you used to reproduce the crash.
 +
 +
References:
 +
* https://sourceforge.net/tracker/?limit=100&func=&group_id=105292&atid=640802&assignee=100&status=1&submit=Filter
 
|}
 
|}
 +
 +
 +
----
 +
 +
== User Interface ==
 +
----
 +
''Tasks related to user experience research or user interface design and interaction''
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Design a prototype CAD GUI layout ===
 +
 +
BRL-CAD's usability is notoriously complex and "expert friendly". MGED and Archer are the main geometry editors, with drastically different user interfaces.
 +
 +
This task involves evaluating the features provided by MGED and Archer, then designing a new GUI layout that encompasses their features while improving usability. Rationale for design decisions and layout should be provided.
 +
 +
References:
 +
* http://brlcad.org/design/gui
 +
 +
Provide one or more mock-up images (png, pdf, psd, html, whatever)
 +
 +
Search for other similar GCI tasks to avoid making a similar design.  You can use any tools, but your work must be original.
 +
|}
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN axis.c ====
 
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create an ISST screenshot or animation ===
 +
 +
Everyone loves to see screenshots and animations of software in action. We use both in our marketing and outreach. See some of the examples below that we already have.
 +
 +
Create an awesome screenshot and/or animation of our 'isst' tool in action. It's an interactive geometry viewer interface.  It should be graphically interesting and give some sense of capability.  You should import a visually complex and interesting model with LOTS of polygons and detail.
 +
 +
References:
 +
* http://brlcad.org/gallery/d/19-4/MGED.jpg
 +
* http://brlcad.org/tmp/archer.png
 +
* http://brlcad.org/gallery/s/screenshots/
 +
* http://www.google-melange.com/gci/task/view/google/gci2012/8019211
 +
 +
Note that we have several screenshot tasks.  Note you may have to go through some or our basic MGED tutorials (see docs section on our website) just to be able to display geometry.  Finally, give others a chance if you already completed one of the other screenshot tasks. ;)
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Categorize all of BRL-CAD's commands into a spreadsheet ===
 +
 +
BRL-CAD is a suite of more than 400 processing tools, image tools, geometry converters, and more. There is an existing spreadsheet that characterizes all of the available commands in terms of inputs, outputs, and options, but there is insufficient characterization of BRL-CAD's commands as to how they logically group and work together.
 +
 +
This task involves building up a spreadsheet that lists all of our commands, describing a finite set of command categories, and characterizing all commands into those categories while filling in the spreadsheet with details for each command.
 +
 +
References:
 +
* A spreadsheet template will be provided.
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN qmath.c ====
 
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Redesign MGED/Archer's Menu ===
 +
 +
BRL-CAD's geometry editing applications, like most graphical applications, have an application menu with a variety of features, capabilities, and options, but with little attention to cohesive design.
 +
 +
Review the menus for MGED and Archer.  Design a new menu system based on both of them that eliminates confusion, is easier to navigate, and has menu options more logically grouped together.
 +
 +
References:
 +
* mged
 +
* archer
 +
 +
Provide screenshots or detailed text indicating what menu options should be available and what exactly is on each menu.
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN rand.c ====
 
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create Wordpress theme for BRL-CAD website ===
 +
 +
BRL-CAD's website was recently redesigned.  The current website uses Drupal and Mediawiki.  Our new website will be using Wordpress and Mediawiki.
 +
 +
This task involves creating a custom Wordpress theme based on our new website design.
 +
 +
References:
 +
* http://cpp-tricks.com/brlcad/
  
−
{| style="background-color:#efefef; border-style: solid; border-width: 4px;" width="100%"
 
−
| style="padding: 20px;" |
 
−
==== ... unit tests for LIBBN vector.c ====
 
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Migrate Drupal site to Wordpress ===
 +
 +
BRL-CAD's main website content runs on Drupal.  There are a lot of articles, user accounts, and other information contained within this installation of Drupal.
 +
 +
This task involves setting up an installation of Wordpress on our production server and migrating the data from Drupal into the Wordpress site.
  
−
&nbsp;
+
References:
 +
* http://brlcad.org/d/
 +
 
 +
This task requires that you establish an account on one of our servers.  There is a setup process involved.  Join us on IRC for details.
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a CSS only version of BRL-CAD Logo ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's logo is very simple and can be easily created with CSS3, such a logo would be a great asset to the new design of BRL-CAD's website.
−
| style="padding: 20px;" |
 
  
−
=== Find, reliably reproduce, and report any bug in Archer ===
+
This task involves at minimum creating a bunch of CSS styles (preferrably a SASS mixin) which result into BRL-CAD's logo. You can take inspiration from
  
−
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
+
http://css-tricks.com/examples/ShapesOfCSS/
  
−
This task involves filing a bug report with verifiable and reproducible steps that clearly demonstrate the bug.  It can't be a bug already reported or otherwise documented nor can it be merely behavior you don't like.
+
You can check the logo at
  
−
References:
+
http://cpp-tricks.com/brl-cad/
−
* archer
 
−
* Introduction to MGED at http://brlcad.org/wiki/Documentation (many of the mged commands are available in some fashion within archer)
 
−
* BUGS file in any source/binary distribution
 
−
* http://sourceforge.net/tracker/?atid=640802&group_id=105292&func=browse
 
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a CAD inspired icon-set for BRL-CAD website ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's new website design uses lot of icons. It would be great if these icons have the look and feel of CAD/CAM in it.
−
| style="padding: 20px;" |
 
−
=== Reproduce any 10 unconfirmed open bug reports ===
 
  
−
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned.  Read the comments and status to see if the bug has been confirmed/reproduced. 
+
So the task consists of making an icon set including icons for:-
 +
* All the menu buttons (About,Downloads,Documentation,Community, Blog, Gallery)
 +
* Sign-Up & Log-In icons
 +
* Major Social Media Icons
  
−
This task involves going through those reports and REPRODUCE at least 10 of the ones that have not been confirmed.  When you can reproduce the issue being reported, you'll comment on the thread to state as much and attach any data you used to reproduce the crash.
+
Few things to keep in mind:-
 +
*All icons should somehow adopt the look and feel of CAD.
 +
*They all should be in PNG/AI/SVG format.
 +
*The icons need not be complexed or textured, though long shadowed flat icons would be appreciated.  
  
−
References:
+
References
−
* https://sourceforge.net/tracker/?limit=100&func=&group_id=105292&atid=640802&assignee=100&status=1&submit=Filter
+
*http://www.awwwards.com/flat-long-shadows-step-by-step-tutorial-resources-and-examples.html
 +
* http://cpp-tricks.com/brlcad/
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a graphical mock-up for wiki pages of BRL-CAD ===
 +
 +
BRL-CAD's website is undergoing a change. BRL-CAD needs a new design for it's wiki pages.
 +
 +
This task requires you to create a graphical (png or jpeg) mock-up of BRL-CAD's wiki pages in any Graphics Manipulations software like GIMP. The mock up should have a color scheme based on the new logo of BRL-CAD, and a design that's consistent with the new website design (http://cpp-tricks.com/brlcad/). As the whole website design is responsive (adapts to the different screen sizes) so design for wiki is expected the same way.
 +
 +
Take a look at wiki pages here
 +
*http://brlcad.org/wiki/Main_Page
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a graphical mock-up for BRL-CAD's Blog ===
 +
 +
BRL-CAD's website is undergoing a change. BRL-CAD needs a new design for it's Blog pages.
 +
 +
This task requires you to create a graphical (png or jpeg) mock-up of BRL-CAD's blog in any Graphics Manipulations software like GIMP. The mock up should have a color scheme based on the new logo of BRL-CAD, and a design that's consistent with the new website design (http://cpp-tricks.com/brlcad/). As the whole website design is responsive (adapts to the different screen sizes) so blog design is expected the same way. You have to make design for
 +
* Blog Archives
 +
* Blog Post Excerpts (paginated)
 +
* A single Post with comments
  
−
== User Interface ==
+
A typographically well set, clean and minimal design will be appreciated.
−
''Tasks related to user experience research or user interface design and interaction''
 
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
|}
−
| style="padding: 20px;" |
 
−
=== Create an ISST screenshot or animation ===
 
  
−
Everyone loves to see screenshots and animations of software in action. We use both in our marketing and outreach. See some of the examples below that we already have.
+
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a graphical mock-up for BRL-CAD's Documentation pages ===
  
−
Create an awesome screenshot and/or animation of our 'isst' tool in action. It's an interactive geometry viewer interface.  It should be graphically interesting and give some sense of capability.  You should import a visually complex and interesting model with LOTS of polygons and detail.  Note you may have to go through some or the MGED tutorials (see Docs on our website).
+
Documentation is part of wiki pages as per now, you can see it at
 +
http://brlcad.org/wiki/Documentation
  
−
References:
+
The task requires you to create a graphical or HTML & CSS/SASS mockup for the  documentation page of BRL-CAD. As it is a wiki page so the mock up created for wiki pages can be used. It should be consistent with main wiki design but at same time different from rest of wiki pages. You can incorporate some content from BRL-CAD's doc book too.
−
* https://brlcad.org/gallery/index.php?/category/12
 
  
−
&nbsp;
 
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a custom wikimedia skin for BRL-CAD ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD's website is undergoing a change. BRL-CAD needs a new design for it's Wiki pages.
−
| style="padding: 20px;" |
 
  
−
=== Categorize commands into a spreadsheet ===
+
BRL-CAD uses media-wiki as the underlying software for the wiki. This taks needs you to create a custom media-wiki skin for BRL-CAD. This media-wiki skin must be based on the graphical mock-up created for it (though there are no restrictions in improvising) and consistent with new website design.
  
−
BRL-CAD is a suite of more than 400 commands, processing tools, image tools, geometry converters, and more. MGED also has a command-line with hundreds of commands too. Help us reorganize one of those command sets.
+
References
 +
*http://cpp-tricks.com/brlcad/
 +
*http://www.mediawiki.org/wiki/Manual:Skinning/Tutorial
  
−
This task involves creating a spreadsheet that lists all commands and groups them together into a finite set of categories or labels.  This spreadsheet will help us identify places where commands can be consolidated, commands we might want to consider removing, common groupings for documentation, etc. 
+
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a web based interactive timeline giving historical tour of BRL-CAD ===
 +
 +
BRL-CAD has history of decades. It would be great to show that history in form of an interactive timeline.
 +
 +
You can do it using any web technology you are comfortable with. I would prefer something like http://plugins.jquery.com/b1njTimeline/ to ease your work. It should be interactive, I should be able to browse through and click on dates and get the details of the events. The color scheme used should be in consistent with the website design. Usage of appropriate imagery would be preferred.
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
===  Design a Cover Photo for Facebook page (and other social networks) ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD got it's logo changed, and it's website is undergoing a change. So this re-branding of BRL-CAD also requires a good, well designed and attractive cover photo for the BRL-CAD's Facebook page or other Social Media Appearances. It should feature a good tagline telling some killer feature of BRL-CAD, BRL-CAD's new logo and/or some illustration/image regarding the feature highlighted in tagline.
−
| style="padding: 20px;" |
 
  
−
===  Design a Cover Photo for Facebook (and other social media) ===
+
It should be consistent with the color scheme of our new website design.
  
−
BRL-CAD website and marketing materials are constantly undergoing change.  Effective marketing requires well designed and attractive imagery. Imagery ideally should showcase some feature of BRL-CAD, some highlight, something visually interesting and compelling.
+
New website design
 +
*http://cpp-tricks.com/brlcad/
  
−
References:
+
|}
−
* https://www.facebook.com/brlcad
 
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
 +
===  Design a banner ad for BRL-CAD ===
 +
 +
BRL-CAD is one of the oldest open source communities. This community has a good following, so we want to give a chance to everyone so that they can show their support to the community by adding a banner ad in their website. You have to create a banner ad that can be embedded in the website by copy pasting some simple lines of code (basically an iframe).
 +
 +
Such a banner ad can also be used in various sections of our own website.
 +
 +
The task requires you to create a CSS3 based animated horizontal and vertical banner add, highlighting some feature of BRL-CAD or making some call to action. This call to action can be joining mailing list, or signing up for community, or link to latest post etc.
 +
 +
For Inspiration and tutorial refer
 +
*http://tympanus.net/Tutorials/AnimatedWebBanners/
 +
 
|}
 
|}
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Creating Motion Typography video for BRL-CAD  ===
  
−
{| style="background-color:#fefefe; border-style: solid; border-width: 4px;" width="100%"
+
BRL-CAD has a lot of great features that can be highlighted. A motion typography video highlighting these features would be a wonderful addition to the front page of website.
−
| style="padding: 20px;" |
 
−
=== Create a video for BRL-CAD  ===
 
  
−
Watching someone else use software is incredibly helpful to some.  Create a screen-cast video for BRL-CAD that showcases some  feature, goes over steps involved in creating some model, or shows how to accomplish some other task.
+
This task requires you to create a motion typography video that will convince user to give BRL-CAD a try, it could be titled something like "x reasons to choose BRL-CAD" or anything similar (give your creative minds a flight). The video should not be more than 2 minutes.  
  
−
You'll need to install BRL-CAD on your computer and use it in the video.  Create or import some model and make a recording.
+
For inspiration about what a motion typography, see
 +
*http://vimeo.com/24715531
 +
 
 +
|}
  
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Create a screen-cast for BRL-CAD  ===
 +
 +
Getting started with BRL-CAD is sometimes not so smooth. A screen-cast giving a tour of BRL-CAD's GUI and the steps involved in creating the first model will make it easy for users to get started.
 +
 +
For this task you need to install BRL-CAD on your computer. Create a very basic model in it and record your screen as you create the model. It should also give a tour of BRL-CAD's workspace. You can choose model of your choice. Keep something very basic and easy for the first time users.
 +
 
|}
 
|}
 +
 +
 
&nbsp;
 
&nbsp;
 +
{| style="background-color:#ffffff;" cellpadding="20" cellspacing="0" border="2" width="100%"
 +
|
 +
=== Loading Google charts from API  ===
 +
 +
A basic wrapper of GCharts has been implemented a while ago : https://bitbucket.org/suryajith/benchmark/src/a27dd8c05d6819a527650e06a63076599d2e0d66/libs/charting.py?at=default With the google charts improving their API system which wasn't around then, see if the code could be optimized so to get the charts the optimal way.
 +
 +
Reference:
 +
*https://developers.google.com/chart/interactive/docs/index
 +
 +
 +
|}
 +
----
  
 
= When You're Done =
 
= When You're Done =
 +
----
  
 
For non-code, just send us your file(s).  For code changes, you will be expected to [[Patches|provide a patch file]].  Make sure you ''read'' your patch file before submitting it.  Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:
 
For non-code, just send us your file(s).  For code changes, you will be expected to [[Patches|provide a patch file]].  Make sure you ''read'' your patch file before submitting it.  Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)
Retrieved from "https://brlcad.org/wiki/Deuces"