build: renaming to sourcetrail
This commit is contained in:
@@ -43,7 +43,7 @@ void deep_thought()
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// 2 - CONTEXT
|
||||
// We just talked about Coati providing context to the important lines of code.
|
||||
// We just talked about Sourcetrail providing context to the important lines of code.
|
||||
// But it feels like something is missing here. What is "the_question"? And
|
||||
// where does it come from?
|
||||
//
|
||||
@@ -51,7 +51,7 @@ void deep_thought()
|
||||
// Do you see the first line of this snippet? I mean the one that has just two
|
||||
// dots as line number and reads "deep_thought". Actually that's the name of
|
||||
// the function's scope that encapsulates the snippet. By clicking that line
|
||||
// you can tell Coati to expand the view to show the entire scope.
|
||||
// you can tell Sourcetrail to expand the view to show the entire scope.
|
||||
// Give it a try!
|
||||
//
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
@@ -32,16 +32,16 @@ void function_with_snippets()
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// 8 - YOU FOUND THE HIDDEN COMMENT
|
||||
// Well done! As you see Coati merged the two snippets from before because
|
||||
// Well done! As you see Sourcetrail merged the two snippets from before because
|
||||
// expanding a scope would have caused them to overlap. That's all for the code
|
||||
// view tutorial.
|
||||
//
|
||||
// 9 - EDIT YOUR CODE
|
||||
// In case you wondered if you can edit your code using Coati: You can't. Coati
|
||||
// In case you wondered if you can edit your code using Sourcetrail: You can't. Sourcetrail
|
||||
// is designed for code exploration, not as a text editor or an IDE. But there
|
||||
// is a chance that Coati can talk to your favorite editor (that you already
|
||||
// is a chance that Sourcetrail can talk to your favorite editor (that you already
|
||||
// know how to operate) via plugin. For more information about available
|
||||
// plugins please take a look at Coati's documentation.
|
||||
// plugins please take a look at Sourcetrail's documentation.
|
||||
//
|
||||
// We hope you enjoyed this tutorial. You can follow the call below to get back
|
||||
// to the central hub.
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// 1 - THE GRAPH TUTORIAL
|
||||
// In Coati's default window layout the graph is shown to the left, next to the
|
||||
// In Sourcetrail's default window layout the graph is shown to the left, next to the
|
||||
// code. It displays the structure of your project where all named symbols are
|
||||
// nodes and all relations are edges. Like the code view it shows only the
|
||||
// currently active symbol and all the incoming and outgoing dependencies.
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
// 3 - WELL DONE
|
||||
// You activated a node and both, the graph and the code view have been updated
|
||||
// accordingly.
|
||||
// Note that even though Coati provides a graph view it does not remove the
|
||||
// Note that even though Sourcetrail provides a graph view it does not remove the
|
||||
// need for reading code. The graph view is great for gaining a quick overview
|
||||
// on relations and navigating code, but once you found something you are
|
||||
// interested in you should still consider the code view to actually read up on
|
||||
@@ -38,7 +38,7 @@ public:
|
||||
{
|
||||
}
|
||||
|
||||
void coati_uses_different_colors()
|
||||
void sourcetrail_uses_different_colors()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ public:
|
||||
// an element with a hatched background please call us. It's a runaway!
|
||||
// Just kidding. Those are elements that are used within your code, but have no
|
||||
// definition anywhere in your source folder (like the "int" symbol on the
|
||||
// right hand side of the graph). So if you click them, Coati will display
|
||||
// right hand side of the graph). So if you click them, Sourcetrail will display
|
||||
// all the relations for the element, but the code view won't show a
|
||||
// definition. If you want to learn more about Coati, go back to the central
|
||||
// definition. If you want to learn more about Sourcetrail, go back to the central
|
||||
// hub. It is called in the function below but you can also try to get there
|
||||
// using only the graph.
|
||||
//
|
||||
|
||||
@@ -21,9 +21,9 @@ public:
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// 6 - FOCUSING EDGES
|
||||
// Even though Coati doesn't allow to activate an edge, you can still focus on
|
||||
// Even though Sourcetrail doesn't allow to activate an edge, you can still focus on
|
||||
// edges. This doesn't change the currently active symbol (which would cause
|
||||
// Coati to hide everything but the edge). Instead Coati just highlights the
|
||||
// Sourcetrail to hide everything but the edge). Instead Sourcetrail just highlights the
|
||||
// relation's location in the code and scrolls you there, so you don't lose
|
||||
// context.
|
||||
// Try to activate an edge that comes from the "ProducerOfTheLastMember" class.
|
||||
|
||||
@@ -8,19 +8,19 @@
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// WHAT JUST HAPPENED?
|
||||
// Coati uses the concept of an "active" symbol. You just changed the active
|
||||
// Sourcetrail uses the concept of an "active" symbol. You just changed the active
|
||||
// symbol by clicking on the name of a function.
|
||||
//
|
||||
// OK, BUT WHAT IS AN ACTIVE SYMBOL?
|
||||
// Coati doesn't show your entire code base on a single screen. Even for
|
||||
// Sourcetrail doesn't show your entire code base on a single screen. Even for
|
||||
// relatively small projects that would be pointless - trust me on that. So
|
||||
// instead of showing everything at once, Coati keeps a strongly focused view
|
||||
// instead of showing everything at once, Sourcetrail keeps a strongly focused view
|
||||
// on your code. This focus only includes the currently active symbol and its
|
||||
// direct relations. Nothing more. By changing the active symbol as you just
|
||||
// did, Coati allows you to jump through the code base on your own.
|
||||
// did, Sourcetrail allows you to jump through the code base on your own.
|
||||
//
|
||||
// I THINK I GOT IT!
|
||||
// Now that you understand Coati's central concept you are ready to activate
|
||||
// Now that you understand Sourcetrail's central concept you are ready to activate
|
||||
// the "my_next_step()" symbol below.
|
||||
//
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
//
|
||||
// 1 - THE SEARCH TUTORIAL
|
||||
// If you haven't messed up anything yet, you'll find the search bar to the
|
||||
// upper left of Coati's user interface. Initially it shows the name of the
|
||||
// upper left of Sourcetrail's user interface. Initially it shows the name of the
|
||||
// currently active symbol.
|
||||
// Use the shortcut "CTRL/CMD + F" to focus the search bar. You can also just
|
||||
// click it. Try that now and enter the string "find_me_if_you_can" to search
|
||||
|
||||
@@ -9,10 +9,10 @@
|
||||
//
|
||||
// 2 - THE AUTOCOMPLETION
|
||||
// I hope you have been lazy enough to not enter the whole string from start to
|
||||
// finish. So you already noticed Coati's autocompletion box.
|
||||
// While you enter your search request Coati already tries to find a subset of
|
||||
// finish. So you already noticed Sourcetrail's autocompletion box.
|
||||
// While you enter your search request Sourcetrail already tries to find a subset of
|
||||
// matching symbols to help you get where you want pretty fast.
|
||||
// But that's not all Coati does. Keep an eye on the search bar while entering
|
||||
// But that's not all Sourcetrail does. Keep an eye on the search bar while entering
|
||||
// the string "aux" and activate the symbol showing up.
|
||||
//
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
@@ -13,10 +13,10 @@
|
||||
// Here comes the bad news: Even though this tutorial contains some code that
|
||||
// would compile, the code doesn't make much sense. So trying to explore this
|
||||
// project any further would be rather unproductive.
|
||||
// The good news is: In addition to this tutorial Coati also ships with a real
|
||||
// The good news is: In addition to this tutorial Sourcetrail also ships with a real
|
||||
// example project that implements the game Tic-Tac-Toe! You can open the
|
||||
// project via the "Project -> Recent Projects" menu.
|
||||
// You can also start exploring your own projects by creating a new Coati
|
||||
// You can also start exploring your own projects by creating a new Sourcetrail
|
||||
// project where you can add all your source and include paths.
|
||||
//
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
@@ -11,9 +11,9 @@
|
||||
//------------------------------------------------------------------------------
|
||||
//
|
||||
// THE HUB
|
||||
// This is the central hub of Coati's tutorial. From here you can embark on
|
||||
// short trips to explore the different parts of Coati. Most important: You
|
||||
// will get to know how all the different parts of Coati interact.
|
||||
// This is the central hub of Sourcetrail's tutorial. From here you can embark on
|
||||
// short trips to explore the different parts of Sourcetrail. Most important: You
|
||||
// will get to know how all the different parts of Sourcetrail interact.
|
||||
// The function below references all the available tutorials. So pick one and
|
||||
// jump right to action.
|
||||
//
|
||||
|
||||
+3
-3
@@ -2,12 +2,12 @@
|
||||
<config>
|
||||
<description>
|
||||
WHAT IS THIS?\n
|
||||
\tThis is a tutorial and it is one of the fastest ways to get to know Coati.\n
|
||||
\tThis is a tutorial and it is one of the fastest ways to get to know Sourcetrail.\n
|
||||
\n
|
||||
WHERE AM I?\n
|
||||
\tYou're looking at Coati's Code View which usually displays source code,\n
|
||||
\tYou're looking at Sourcetrail's Code View which usually displays source code,\n
|
||||
\tbut every time a new project is loaded it gives a quick summary to\n
|
||||
\testimate the project's size. This is a fairly small project. It only\n
|
||||
\testimate the project's size. This is a fairly small project. It only\n
|
||||
\tcontains a few hundred lines of code as you can see by the numbers below.\n
|
||||
\n
|
||||
LET'S GET STARTED!\n
|
||||
Reference in New Issue
Block a user