TriBITS icon indicating copy to clipboard operation
TriBITS copied to clipboard

Create initial TriBITS tutorial

Open bartlettroscoe opened this issue 8 years ago • 5 comments

Description:

This story will track the creation of a new TriBITS tutorial.

ToDo: Fill in more scope ...

@fryeguy52 will primarily work on this as part of learning TriBITS.

bartlettroscoe avatar May 10 '17 20:05 bartlettroscoe

Need to decide on a few things:

  1. What format to use (e.g. RST, MarkDown, Latex, etc.)? => RST (use TriBITS Developers Guide as tempate)
  2. What the outline should look like? => Just try something and we can talk

bartlettroscoe avatar May 10 '17 21:05 bartlettroscoe

@fryeguy52,

Create branch tribits-tutorial-190 and put in our GitHub fork using:

$ git clone [email protected]:TriBITSPub/TriBITS.git
$ cd TriBITS/  # This is on 'master' tracking 'origin/master'
$ git remote add fryeguy52 [email protected]:fryeguy52/TriBITS.git
$ git fetch fryeguy52  # Just make sure you have this right
$ git checkout -b tribits-tutorial-190 origin/master
$ git push -u fryeguy52 tribits-tutorial-190

Then just make all of your changes on your local tribits-tutorial-190 branch and push to your remote tracking branch to backup and show progress with:

[frye??  (tribits-tutorial-190)$] git push  # to fryeguy52

And, please put #190 in all of your commit messages (e.g. in the Summary line blah blah blah (#190)).

bartlettroscoe avatar May 10 '17 21:05 bartlettroscoe

@fryeguy52, note that I just pushed the commit 959cb9e that should fix the behavior of <Project>_ENABLE_Fortran_DEFAULT that we saw yesterday.

bartlettroscoe avatar May 18 '17 19:05 bartlettroscoe

@fryeguy52, I rebased your branch tribits_tutorial pointed to in PR #192 and pushed it as the branch tribits-tutorial-190. That gets rid of the intermediate merge commits, etc. I tried to build the document and it failed:

$ cd TriBITS/
$ cd tribits/doc/tribits_tutorial/

$ ./generate-tutorial.sh
Generating HTML and PDF files ...
This is pdfTeXk, Version 3.141592-1.40.3 (Web2C 7.5.6)
 %&-line parsing enabled.
entering extended mode
! I can't find file `../TribitsTutorialHelloWorld_0.tex'.
<*> ../TribitsTutorialHelloWorld_0.tex
                                      
(Press Enter to retry, or Control-D to exit)
Please type another input file name: 

I updated the script generate-tutorial.sh to fix the paths and got the documents to build.

bartlettroscoe avatar Jul 05 '17 20:07 bartlettroscoe

@fryeguy52, I just merged PR #267. Let's try to find someone willing to view this material. Otherwise, I will take a look a little later.

bartlettroscoe avatar Sep 12 '18 23:09 bartlettroscoe