Bläddra i källkod

Port minor README fixes

Arkadiusz Ryś 2 år sedan
förälder
incheckning
28d11a66a8
1 ändrade filer med 8 tillägg och 8 borttagningar
  1. 8 8
      README.rst

+ 8 - 8
README.rst

@@ -127,9 +127,9 @@ Therefore, SPARQL knowledge requirements are minimized while still allowing serv
 Installation
 ------------
 
-If you are on Windows you can download the binary at URL and run it by double-clicking it.
+If you are on Windows, you can download the binary at URL and run it by double-clicking it.
 
-We also provide the option to install the package from a repository. If this is your preferred method please follow along.
+We also provide the option to install the package from a repository. If this is your preferred method, please follow along.
 
 ..
    .. code-block:: shell
@@ -146,7 +146,7 @@ We also provide the option to install the package from a repository. If this is
 .. role:: bash(code)
    :language: bash
 
-To run the application you can use :bash:`python3 -m graph-exploring-tool`.
+To run the application, you can use :bash:`python3 -m graph-exploring-tool`.
 
 For WSL check out: https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps
 
@@ -178,7 +178,7 @@ The tool separates actions into multiple panels.
 1. The left Query Palette panel **(red)** allows you to load a predefined template. Hovering over the name of the template will provide a tooltip with the description of the action carried out by that template.
 2. The center and main Query Editor panel **(green)** is where the template is shown once it has been chosen. You can change the template itself or use the provided fields **(blue)** to insert references into the template itself.
    The reference fields support dragging and dropping.
-   To perform the query you need to click the Query button.
+   To perform the query, you need to click the Query button.
 3. The small one line panel **(yellow)** show the status. This includes messages whether a query was successful. Any error will also be displayed right here.
 4. The most important panel is the Results panel **(orange)**. Any information returned by the query will be displayed here.
    You can drag and drop any of the fields in the result onto the parameters fields in the template.
@@ -190,13 +190,13 @@ Workflow
 We propose a simple workflow:
 You open up the FTGPM++ (workflow diagram) and look at what is of interest to you.
 Let's say you are interested in finding all the individuals (or instances) of a certain type.
-You look at the Query Palette panel. You see the first options which is what you need.
+You look at the Query Palette panel. You see the first option, which is what you need.
 Now you click on this (Find Individuals) button. Here you see that you need to specify two parameters.
 
 - We need to know what class the individuals you're looking for belong to and perhaps a relation to another individual.
 
-The example assumes you want to find all Formalisms and their name.
-At this point you can execute the query by clicking the Query button.
+The example assumes you want to find all `Formalisms` and their name.
+At this point, you can execute the query by clicking the Query button.
 The list of corresponding individuals will now be visible in the Results panel.
 You can now use these results to further query the graph.
 
@@ -227,7 +227,7 @@ Each template has required fields.
 - The :bash:`name`: A short identifier for the template.
 - The :bash:`prefix` list: A string containing the full prefix for the query.
 - The :bash:`query` template: The query itself. Placeholder can be defined between double curly brackets.
-- The :bash:`description`: A longer description for the template which will be shown as the tooltip.
+- The :bash:`description`: A longer description for the template, which will be shown as the tooltip.
 - Whether :bash:`visual_support` is enabled: Deprecated. Always true.
 - A list of :bash:`replacements` each having 3 fields: One needs to be defined for each placeholder in the query.