Skip to content

Commit

Permalink
Updated links
Browse files Browse the repository at this point in the history
  • Loading branch information
alexlang74 committed Sep 4, 2024
1 parent 8ea46ce commit 96e1a05
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ IBM Granite.Code is an innovative, lightweight AI coding companion powered by IB
- Chat with an [IBM Granite](https://www.ibm.com/granite "target=_blank") code model to create code, and ask general programming questions.
- Use the chat to explain and extend existing code from your workspace.

![explain](https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/Explain.png)
![explain](https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/Explain.png)

### Code completion

Complete the line that you're currently typing:

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/Single-line.gif" height=200 alt="Single-line completion in IBM Granite.Code">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/Single-line.gif" height=200 alt="Single-line completion in IBM Granite.Code">

And even full methods and functions:

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/Multi-line.gif" height=350 alt="Multi-line completion in IBM Granite.Code">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/Multi-line.gif" height=350 alt="Multi-line completion in IBM Granite.Code">

### Turn comments into code

Create a comment that describes a function, method, or piece of logic in your editor, and have IBM Granite.Code create it.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/comment-to-code.gif" height=200 alt="Comment to code generation in IBM Granite.Code">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/comment-to-code.gif" height=200 alt="Comment to code generation in IBM Granite.Code">

### Everything is local, configurable by you

Expand Down Expand Up @@ -142,7 +142,7 @@ IBM Granite.Code does _not_ collect any telemetry data. In general, IBM Granite.

### Starting the chat

1. Open the IBM Granite.Code view by selecting _View -> Open View -> IBM Granite.Code_ in the menu, or clicking the _IBM Granite.Code_ icon in the sidebar <img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/granite-icon.png" height=20 alt="IBM Granite.Code View Icon">
1. Open the IBM Granite.Code view by selecting _View -> Open View -> IBM Granite.Code_ in the menu, or clicking the _IBM Granite.Code_ icon in the sidebar <img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/granite-icon.png" height=20 alt="IBM Granite.Code View Icon">
2. The chat panel opens to the left of the Visual Studio Code editor.
3. To move the chat, drag the icon to the right or bottom of the editor.

Expand All @@ -152,7 +152,7 @@ IBM Granite.Code does _not_ collect any telemetry data. In general, IBM Granite.

Enter a free-text question or instruction and click **Enter**. IBM Granite.Code sends your input to the code model, and shows the response in the chat.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/NL-chat.png" height=200 alt="IBM Granite.Code Chat">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/NL-chat.png" height=200 alt="IBM Granite.Code Chat">

#### Reference code

Expand All @@ -163,7 +163,7 @@ To ask questions or refine a specific file, class, function, or method in your w
3. Start typing the characters of the file, class, or method name you want to reference. The list filters automatically.
4. Select the reference.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/references.gif" height=200 alt="IBM Granite.Code code references">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/references.gif" height=200 alt="IBM Granite.Code code references">

IBM Granite.Code sends the contents of the reference automatically to the model as part of your message.

Expand Down Expand Up @@ -212,7 +212,7 @@ To rename a chat conversation:
3. Select the menu on the right of the conversation.
4. Click **Rename**.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/Chat-Options.png" height=200 alt="IBM Granite.Code chat options">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/Chat-Options.png" height=200 alt="IBM Granite.Code chat options">

#### Writing effective chat messages

Expand All @@ -233,7 +233,7 @@ IBM Granite.Code and the Granite code models are created to answer questions tha
2. IBM Granite.Code adds a code suggestion to complete the line that you typed.
3. Press **Tab** to accept the suggestion.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/Single-line.gif" height=200 alt="Single-line completion in IBM Granite.Code">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/Single-line.gif" height=200 alt="Single-line completion in IBM Granite.Code">

### Multi-line completion

Expand All @@ -242,7 +242,7 @@ IBM Granite.Code and the Granite code models are created to answer questions tha
3. IBM Granite.Code adds a code suggestion to complete the line that you typed, and adds code lines.
4. Press **Tab** to accept the suggestion.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/Multi-line.gif" height=350 alt="Multi-line completion in IBM Granite.Code">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/Multi-line.gif" height=350 alt="Multi-line completion in IBM Granite.Code">

### Comment-to-code

Expand All @@ -251,7 +251,7 @@ IBM Granite.Code and the Granite code models are created to answer questions tha
3. IBM Granite.Code adds a code suggestion based on your comment.
4. Press **Tab** to accept the suggestion.

<img src="https://github.com/IBM/ibm-granite-code-ide/raw/HEAD/images/comment-to-code.gif" height=200 alt="Comment to code generation in IBM Granite.Code">
<img src="https://github.com/ibm-granite/granite-code-ide/raw/HEAD/images/comment-to-code.gif" height=200 alt="Comment to code generation in IBM Granite.Code">

### Tips for generating code

Expand Down

0 comments on commit 96e1a05

Please sign in to comment.