mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-04-23 22:52:11 +02:00
Bug 149388, Updated CDT basic and import project tutorials to cheatsheet format. Combined basic and importing cheatsheet updates.
This commit is contained in:
Ken Ryall
parent
ec229c0635
commit
d534cbff86
3 changed files with 218 additions and 0 deletions
85
doc/org.eclipse.cdt.doc.user/cheatsheets/cs_cdt_basic.xml
Normal file
85
doc/org.eclipse.cdt.doc.user/cheatsheets/cs_cdt_basic.xml
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<cheatsheet title="Creating a C/C++ Managed Make project">
|
||||
<intro href="/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm">
|
||||
<description>
|
||||
This guide will walk you though the process of creating a simple Managed "Hello World" application using the CDT.
|
||||
</description>
|
||||
</intro>
|
||||
<item title="C/C++ workbench setup" dialog="false" skip="false" href="/org.eclipse.cdt.doc.user/concepts/cdt_c_perspectives.htm">
|
||||
<description>
|
||||
Start by setting up the CDT development environment.
|
||||
</description>
|
||||
<subitem label="Open C/C++ perspective." skip="true">
|
||||
<command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.cdt.ui.CPerspective)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Creating a C/C++ project" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/reference/cdt_u_new_proj_wiz.htm">
|
||||
<description>
|
||||
Choose one type of C/C++ project from the list. Then type a project name and type of project.
|
||||
</description>
|
||||
<subitem label="Click File > New > CDT Project." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.managedbuilder.ui.wizards.NewCWizard3)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Click File > New > C++ Project." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.managedbuilder.ui.wizards.NewCWizard1)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Click File > New > C Project." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.managedbuilder.ui.wizards.NewCWizard2)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Creating files in the project" dialog="true" skip="false" href="/org.eclipse.platform.doc.user/tasks/tasks-44.htm">
|
||||
<description>
|
||||
For a project to work it needs files. In this step you add one or more files to your project.
|
||||
</description>
|
||||
<subitem label="Click File > New > File to create a new source file." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.ui.wizards.NewFileCreationWizard)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Type a name for the new file. For example main.c for a C project." skip="true">
|
||||
</subitem>
|
||||
<subitem label="Type some code into the main.c file. For example: #include <stdio.h> int main(int argc, char **argv) { printf ("Hello\n"); return (0); }" skip="true">
|
||||
</subitem>
|
||||
<subitem label="Click File > Save to save your new file." skip="true">
|
||||
<command serialization="org.eclipse.ui.file.save" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Building projects and inspecting files" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm">
|
||||
<description>
|
||||
In this step you build the program to create a binary and examine it in a couple of C/C++ perspective views.
|
||||
</description>
|
||||
<subitem label="Click Project > Build All to create a binary of your source file." skip="true">
|
||||
<command serialization="org.eclipse.ui.project.buildAll" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Examine the Outline view." skip="true">
|
||||
<command serialization="org.eclipse.cdt.ui.edit.open.outline" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Examine the program's binary." skip="true">
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Running the program" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/reference/cdt_u_run_dbg_main.htm">
|
||||
<description>
|
||||
The final step is to create a run configuration that defines how the program is launched. Note you can define multiple run configurations if desired, each with its own settings.
|
||||
</description>
|
||||
<subitem label="Click Run > Run.. to run the program." skip="true">
|
||||
<command serialization="org.eclipse.debug.ui.commands.OpenRunConfigurations" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Create a run configuration by double-clicking the C/C++ Local Application item." skip="true">
|
||||
</subitem>
|
||||
<subitem label="In the Main tab, click Search Program to select the binary to run." skip="true">
|
||||
</subitem>
|
||||
<subitem label="In the Program Selection dialog box, select the binary to run with this run configuration, then click OK." skip="true">
|
||||
</subitem>
|
||||
<subitem label="Click Apply, then click Run to launch the program. The Console view displays the program output." skip="true">
|
||||
<command serialization="org.eclipse.ui.console.ConsoleView" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
</cheatsheet>
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<cheatsheet title="Importing a C/C++ Managed Make Project">
|
||||
<intro>
|
||||
<description>
|
||||
This guide walks you though the process of importing a Managed Make project into CDT. A managed make project is one where the makefile is managed by the tool, not by manually editing it.
|
||||
</description>
|
||||
</intro>
|
||||
<item title="C/C++ workbench setup" dialog="false" skip="false" href="/org.eclipse.cdt.doc.user/concepts/cdt_c_perspectives.htm">
|
||||
<description>
|
||||
Start by setting up the CDT development environment.
|
||||
</description>
|
||||
<subitem label="Open C/C++ perspective." skip="true">
|
||||
<command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.cdt.ui.CPerspective)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Creating a C/C++ Managed Make project" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/reference/cdt_u_new_proj_wiz.htm">
|
||||
<description>
|
||||
Choose one type of C/C++ project from the list. Then type a project name, the type of project, and the No Indexer setting.
|
||||
</description>
|
||||
<subitem label="Click File > New > CDT Project." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.managedbuilder.ui.wizards.NewCWizard1)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Click File > New > C++ Project." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.managedbuilder.ui.wizards.NewCWizard1)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Click File > New > C Project." skip="true">
|
||||
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.managedbuilder.ui.wizards.NewCWizard2)" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Importing files to the project" dialog="true" skip="false" href="/org.eclipse.platform.doc.user/tasks/tasks-53.xhtml">
|
||||
<description>
|
||||
For a project to work it needs files. In this step you import your old project files into your new Managed Make project.
|
||||
</description>
|
||||
<subitem label="Click File > Import and then use one of the following import methods." skip="true">
|
||||
<command serialization="org.eclipse.ui.file.import" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="To import files from another project, click General > Existing Projects into Workspace." skip="true">
|
||||
</subitem>
|
||||
<subitem label="To import files from the file system, click General > File System." skip="true">
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Building projects and inspecting files" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm">
|
||||
<description>
|
||||
In this step you build the program to create a binary and examine it in a couple of C/C++ views.
|
||||
</description>
|
||||
<subitem label="Click Project > Build All to create a binary of your source file." skip="true">
|
||||
<command serialization="org.eclipse.ui.project.buildAll" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Examine the Outline view." skip="true">
|
||||
<command serialization="org.eclipse.cdt.ui.edit.open.outline" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Examine the program's binary." skip="true">
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Setup project properties" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/reference/cdt_u_sprop_indexer.htm">
|
||||
<description>
|
||||
With the project imported and able to build, its time now to reset some project properties for easier development.
|
||||
</description>
|
||||
<subitem label="Right-click the project name in the C/C++ Projects view, then click Properties." skip="true">
|
||||
</subitem>
|
||||
<subitem label="Click C/C++ Indexer, then select Full C/C++ Indexer from the Select Indexer list." skip="true">
|
||||
</subitem>
|
||||
</item>
|
||||
<item title="Running the program" dialog="true" skip="false" href="/org.eclipse.cdt.doc.user/reference/cdt_u_run_dbg_main.htm">
|
||||
<description>
|
||||
The final step is to create a run configuration that defines how the program is launched. Note you can define multiple run configurations if desired, each with its own settings.
|
||||
</description>
|
||||
<subitem label="Click Run > Run.. to run the program." skip="true">
|
||||
<command serialization="org.eclipse.debug.ui.commands.OpenRunConfigurations" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
<subitem label="Create a run configuration by double-clicking the C/C++ Local Application item." skip="true">
|
||||
</subitem>
|
||||
<subitem label="In the Main tab, click Search Program to select the binary to run." skip="true">
|
||||
</subitem>
|
||||
<subitem label="In the Program Selection dialog box, select the binary to run with this run configuration, then click OK." skip="true">
|
||||
</subitem>
|
||||
<subitem label="Click Apply, then click Run to launch the program. The Console view displays the program output." skip="true">
|
||||
<command serialization="org.eclipse.ui.console.ConsoleView" confirm="false">
|
||||
</command>
|
||||
</subitem>
|
||||
</item>
|
||||
</cheatsheet>
|
||||
|
|
@ -71,5 +71,48 @@
|
|||
plugin="org.eclipse.cdt.launch">
|
||||
</contexts>
|
||||
</extension>
|
||||
|
||||
<!-- ============================================================================= -->
|
||||
<!-- KEYWORD INDEX EXTENSION -->
|
||||
<!-- ============================================================================= -->
|
||||
<!--
|
||||
<extension
|
||||
point="org.eclipse.help.index" >
|
||||
<index file="index.xml" />
|
||||
</extension>
|
||||
-->
|
||||
|
||||
|
||||
!-- ============================================================================= -->
|
||||
<!-- CHEATSHEET EXTENSION -->
|
||||
<!-- ============================================================================= -->
|
||||
|
||||
<extension
|
||||
point="org.eclipse.ui.cheatsheets.cheatSheetContent">
|
||||
<category
|
||||
id="org.eclipse.cdt-doc.category.tutorials"
|
||||
name="C/C++ Development">
|
||||
</category>
|
||||
<cheatsheet
|
||||
category="org.eclipse.cdt-doc.category.tutorials"
|
||||
composite="false"
|
||||
contentFile="$nl$/org.eclipse.cdt.doc.user/cheatsheets/cs_cdt_basic.xml"
|
||||
id="org.eclipse.cdt-doc.cheatsheet.cdt_basic"
|
||||
name="Creating a C/C++ Managed Make project">
|
||||
<description>
|
||||
Use this tutorial to learn how to create a simple C/C++ project that uses the Managed Make system.
|
||||
</description>
|
||||
</cheatsheet>
|
||||
<cheatsheet
|
||||
category="org.eclipse.cdt-doc.category.tutorials"
|
||||
composite="false"
|
||||
contentFile="$nl$/org.eclipse.cdt.doc.user/cheatsheets/cs_cdt_import_project.xml"
|
||||
id="org.eclipse.cdt-doc.cheatsheet.cdt_basic"
|
||||
name="Importing a C/C++ Managed Make Project">
|
||||
<description>
|
||||
Use this tutorial to learn how to successfully import a CDT project.
|
||||
</description>
|
||||
</cheatsheet>
|
||||
</extension>
|
||||
|
||||
</plugin>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue