Skip to content

Commit f18aeef

Browse files
authored
Update README.md
1 parent 60c7a07 commit f18aeef

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
11
Welcome to your shiny new Codespace running CodeQL! We've got everything fired up and running for you to explore CodeQL.
22

3-
You've got a blank canvas to work on from a git perspective as well. There's a single initial commit with the what you're seeing right now - where you go from here is up to you!
3+
You've got a blank canvas to work on from a git perspective as well. There's a single initial commit with what you're seeing right now - where you go from here is up to you!
44

5-
Everything you do here is contained within this one codespace. There is no repository on GitHub yet. If and when you’re ready you can click "Publish Branch" and we’ll create your repository and push up your project. If you were just exploring then and have no further need for this code then you can simply delete your codespace and it's gone forever.
5+
Everything you do here is contained within this one codespace. There is no repository on GitHub yet. If and when you’re ready you can click **Publish Branch** and we’ll create your repository and push up your project. If you were just exploring and have no further need for this code then you can simply delete your codespace and it's gone forever.
66

77
## Running the code tour
88

9-
We've set up a code tour to help you get familiar with a CodeQL project and how to run queries. To run the code tour:
9+
We've set up a code tour to help you get familiar with a CodeQL project and how to run CodeQL queries. To run the code tour:
1010

1111
1. In your codespace, at the bottom of the File Explorer, expand **CODETOUR**.
12-
1. Expand the **CodeQL tutorial**, then click **#1**.
12+
1. Under **CODETOUR**, expand the **CodeQL tutorial**, then click **#1**.
1313
1. In the resulting pop up in the Editor, follow along with the tutorial, and press **Next** when you're ready to move on to the next step.
1414

15-
Once you've finished the code tour, you can continue to explore the CodeQL template we've set up for you!
15+
Once you've finished the code tour, your CodeQL environment will be all set up and ready to use! You can continue to explore the CodeQL template we've made for you, and execute your own CodeQL queries.
1616

17-
## Running custom queries
17+
## Running custom CodeQL queries
1818

19-
You can use this template to write and run your own CodeQL queries.
19+
You can use this codespace to write and run your own CodeQL queries.
2020

21-
1. Create your own `.ql` file, or use an existing `.ql` file to write CodeQL queries.
22-
1. Once you've written your queries, right-click within a .ql query file, and click **CodeQL: Run Query**, or
23-
1. Open the Command Palette with `Cmd/Ctrl + Shift + P`, start typing CodeQL, and click on **CodeQL: Run Query**.
21+
1. Create your own `.ql` file, or use an existing `.ql` file to write a CodeQL query.
22+
1. Once you've written your query, right-click within the `.ql` query file, and click **CodeQL: Run Query**, or
23+
1. Open the Command Palette with `Cmd/Ctrl + Shift + P`, start typing "CodeQL", and click on **CodeQL: Run Query**.
2424

2525
## Querying an existing codebase
2626

2727
If you would like to use CodeQL to analyze your own projects, you can follow the instructions in [Setting up CodeQL in Visual Studio Code](https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/) to set up your own CodeQL environment.
28+
29+
## Further learning
30+
31+
You can find CodeQL tutorials in our [CodeQL documentation](https://codeql.github.com/docs/writing-codeql-queries/ql-tutorials/). The tutorials provide practice problems that you can use this codespace to work through.

0 commit comments

Comments
 (0)