Editing Google Season of Docs/2019

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:
= A Beginner’s Guide to BRL-CAD =
+
Project description
 
 
== Project description==
 
 
 
 
This project aims at introducing students to the world of BRL-CAD. It is a beginner’s guide so the main focus is on making the reader familiar with this software and getting them started. The project is a step by step tutorial to model a chess set. Since the target audience is high school students, therefore, this project makes sure the students are well-fed with the required information and keeping it simple at the same time.  
 
This project aims at introducing students to the world of BRL-CAD. It is a beginner’s guide so the main focus is on making the reader familiar with this software and getting them started. The project is a step by step tutorial to model a chess set. Since the target audience is high school students, therefore, this project makes sure the students are well-fed with the required information and keeping it simple at the same time.  
  
== Results ==
+
Here is the pdf to the Beginner's guide to BRL-CAD:
 
+
http://brlcad.org/w/images/9/90/Intro_to_BRL-CAD.pdf
Here's the documentation produced under the 2019 Google Season of Docs:
 
 
 
{{pdf|Intro_to_BRL-CAD|Beginner's guide to BRL-CAD}}
 
 
 
== Summary of the current state of the project==
 
  
 +
Summary of the current state of the project
 
Currently, the project provides complete documentation to model a chess set. It introduces the new users to the BRL-CAD software and helps them successfully model a chessboard and the chess pieces: Rook, King, Queen, Pawn, Bishop, Knight. The next steps are the preparation of the document in the Docbook/XML format so the PDF and HTML forms can be auto-generated and keep it up to date with development changes.
 
Currently, the project provides complete documentation to model a chess set. It introduces the new users to the BRL-CAD software and helps them successfully model a chessboard and the chess pieces: Rook, King, Queen, Pawn, Bishop, Knight. The next steps are the preparation of the document in the Docbook/XML format so the PDF and HTML forms can be auto-generated and keep it up to date with development changes.
  
  
== A list of challenges and learning==
+
A list of challenges and learning
 
+
- BRL-CAD requires a lot of practice to master. I modeled a lot of shapes to understand the commands so that I can explain them in an easier manner.
# BRL-CAD requires a lot of practice to master. I modeled a lot of shapes to understand the commands so that I can explain them in an easier manner.
+
- Modeling BRL-CAD changed the way I look at designs.  
# Modeling BRL-CAD changed the way I look at designs.  
+
- The major challenge I faced was when I tried to model the chessboard and the first chess piece pawn. Mentors helped me improve and then I could model any piece in very less time.
# The major challenge I faced was when I tried to model the chessboard and the first chess piece pawn. Mentors helped me improve and then I could model any piece in very less time.
+
- Another challenge I faced was to explain the measurements and dimensions in an easier fashion so that the readers don’t leave confused.
# Another challenge I faced was to explain the measurements and dimensions in an easier fashion so that the readers don’t leave confused.
+
- I learned a lot about keeping your readers in mind while writing the doc which is one of the key ingredients for writing anything. I learned this by looking at my mentors.
# I learned a lot about keeping your readers in mind while writing the doc which is one of the key ingredients for writing anything. I learned this by looking at my mentors.
 

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)

Template used on this page: