Skip to content

Commit

Permalink
Product documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
AmitBM committed May 3, 2018
1 parent 0ed175b commit 3c8479e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
28 changes: 14 additions & 14 deletions docs/source/help_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Home Page
-------------
At the top of the home page, you will find two tabs:

.. image:: images/007_home_page_b_tabs.PNG
.. image:: images/007_home_page_b_tabs.png
:width: 4.25532in
:height: 2.47686in

Expand All @@ -24,35 +24,35 @@ RGA will automatically create for you the project when you add or create a file

To add an existing .cl source file, use Ctrl+O or click on "Open existing .cl file" under the Start section:

.. image:: images/001_open_file_link_button.PNG
.. image:: images/001_open_file_link_button.png
:width: 4.25532in
:height: 2.47686in

You can also do this by clicking on File -> "Open existing .cl file":

.. image:: images/001_open_file_menu_bar.PNG
.. image:: images/001_open_file_menu_bar.png
:width: 4.25532in
:height: 2.47686in

In a similar way, you can create a project by creating an empty .cl file. Use the Ctrl+N shortcut or click on "Create new .cl file".

You will then be prompted for an optional rename of your project:

.. image:: images/002_rename_project.PNG
.. image:: images/002_rename_project.png

RGA will use a yyyymmdd-hhmmss date-time string as a default name. Check the "Always use auto-generated project names" check box to instruct RGA to always use the default name without prompting for renaming.

Loading a Project
"""""""""""""""""
You can load an existing project (.rga file) using the Ctrl+Alt+O shortcut or by clicking on an item on the Recent menu in the home page:

.. image:: images/007_home_page_b_recent.PNG
.. image:: images/007_home_page_b_recent.png
:width: 4.05532in
:height: 1.17686in

It is also possible to load a project from the File -> "Open existing RGA project..." menu item:

.. image:: images/008_home_page_b_open_project.PNG
.. image:: images/008_home_page_b_open_project.png
:width: 4.25532in
:height: 2.87686in

Expand All @@ -64,7 +64,7 @@ Application
"""""""""""
The Application page controls configurable parts of the app:

.. image:: images/010_home_page_b_settings_app.PNG
.. image:: images/010_home_page_b_settings_app.png
:width: 5.55532in
:height: 4.27686in

Expand Down Expand Up @@ -210,7 +210,7 @@ Using the File Menu you can:
* Create a new source file by clicking on "Create file", or using the Ctrl+N shortcut
* Open the project-specific build settings by clicking on "Build settings", or using the F8 shortcut. For more details about the build settings view, please see the Build Settings section.

.. image:: images/012_build_view_file_menu.PNG
.. image:: images/012_build_view_file_menu.png
:width: 2.25532in
:height: 4.87686in

Expand All @@ -226,23 +226,23 @@ On the left side of the Source Code View, you will find running line numbers.

You can use the Ctrl+F (Edit -> Find) and Ctrl+G (Edit -> Go to...) to search for a string or jump to a specific line.

.. image:: images/013_build_view_source_view.PNG
.. image:: images/013_build_view_source_view.png
:width: 8.25532in
:height: 8.87686in

After a successful build, when the disassembly view becomes visible alongside the Source Code View,
you can double click-on the view's black title bar to maximize it.
You can also click on the resize icon at the top right corner to maximize/minimize the view:

.. image:: images/013_build_view_title_bar.PNG
.. image:: images/013_build_view_title_bar.png
:width: 8.25532in
:height: 1.87686in

Build Output View
^^^^^^^^^^^^^^^^^
When a build is triggered, the RGA command line app is being launched to execute the build. Its output would be streamed into the Build Output View.

.. image:: images/014_build_view_build_output.PNG
.. image:: images/014_build_view_build_output.png
:width: 8.25532in
:height: 3.87686in

Expand All @@ -254,7 +254,7 @@ Disassembly View
^^^^^^^^^^^^^^^^
The disassembly for the relevant kernel will be displayed in the disassembly view on the right:

.. image:: images/006_disassembly_view.PNG
.. image:: images/006_disassembly_view.png
:width: 6.08333in
:height: 4.08568in

Expand Down Expand Up @@ -316,13 +316,13 @@ Load existing Project
^^^^^^^^^^^^^^^^^^^^^
You can load an existing project (.rga file) using the Ctrl+Alt+O shortcut or by clicking on an item on the Recent menu in the home page:

.. image:: images/007_home_page_b_recent.PNG
.. image:: images/007_home_page_b_recent.png
:width: 4.05532in
:height: 1.17686in

It is also possible to load a project from the File -> "Open existing RGA project..." menu item:

.. image:: images/008_home_page_b_open_project.PNG
.. image:: images/008_home_page_b_open_project.png
:width: 4.25532in
:height: 2.87686in

Expand Down
12 changes: 6 additions & 6 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ RGA will automatically create for you the project when you add or create a file

To add an existing .cl source file, use Ctrl+O or click on "Open existing .cl file" under the Start section:

.. image:: images/001_open_file_link_button.PNG
.. image:: images/001_open_file_link_button.png
:width: 4.25532in
:height: 2.47686in

You can also do this by clicking on File -> "Open existing c.l file":

.. image:: images/001_open_file_menu_bar.PNG
.. image:: images/001_open_file_menu_bar.png
:width: 4.25532in
:height: 2.47686in

In a similar way, you can create a project by creating an empty .cl file. Use the Ctrl+N shortcut or click on "Create new .cl file".

You will then be prompted for an optional rename of your project:

.. image:: images/002_rename_project.PNG
.. image:: images/002_rename_project.png

RGA will use a yyyymmdd-hhmmss date-time string as a default name. Check the "Always use auto-generated project names" check box to instruct RGA to always use the default name without prompting for renaming.

Expand All @@ -39,7 +39,7 @@ Generating Disassembly
To build your project and generate the disassembly, use the Ctrl+Shift+B shortcut.
Alternatively, you can use the Build -> Build project menu item:

.. image:: images/003_build_project.PNG
.. image:: images/003_build_project.png
:width: 4.25532in
:height: 1.82522in

Expand All @@ -50,13 +50,13 @@ In case of a build success, the list of kernels in each file would be shown unde

Use that list to control which kernel is in focus (highlighted in yellow):

.. image:: images/005_project_file_menu.PNG
.. image:: images/005_project_file_menu.png
:width: 2.45532in
:height: 0.6in

The disassembly for the relevant kernel will be displayed in the disassembly view on the right:

.. image:: images/006_disassembly_view.PNG
.. image:: images/006_disassembly_view.png
:width: 6.08333in
:height: 4.08568in

Expand Down

0 comments on commit 3c8479e

Please sign in to comment.