Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
language checked
  • Loading branch information
@stephen-hero
stephen-hero authored May 29, 2024
1 parent 7a2897b commit 67f7749
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
[![Gradle Build With Detekt](https://github.com/jetbrains-academy/kotlin-course-template/actions/workflows/gradle-build-with-detekt.yml/badge.svg)](https://github.com/jetbrains-academy/kotlin-course-template/actions/workflows/gradle-build-with-detekt.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This course is designed for novices in plugin development for JetBrains IDEs. It covers the basics of plugin development and provides a hands-on experience in working with PSI (Program Structure Interface) elements.
The main goal of the course is not to rewrite the existing documentation, but rather to cover popular topics and provide links to the official documentation, so that the students can get used to reading the documentation and searching for the necessary information.
This course is designed for novices in plugin development for JetBrains IDEs. It covers the basics of plugin development and provides hands-on experience in working with PSI (Program Structure Interface) elements.
The main goal of the course is not to rewrite the existing documentation but rather to cover popular topics and provide links to the official documentation so that students can get used to reading the documentation and searching for necessary information.

Each lesson of the course consist of a theoretical task and a few programming tasks. The theoretical tasks are designed to help you understand the topic, while the programming tasks aim to apply the acquired knowledge.
At the end of each chapter, an additional final project will be offered. It includes all the topics of the lesson but does not contain theory part. It is divided into multiple tasks, and by completing them step by step, you will get a finished small project in the end.
Each lesson of the course consists of a theoretical task and a few programming tasks. The theoretical tasks are designed to help you understand the topic, while the programming tasks aim to apply the acquired knowledge.
At the end of each chapter, an additional final project will be offered. It includes all the topics of the lesson but does not contain a theory part. It is divided into multiple tasks, and by completing them step by step, you will get a finished small project in the end.

Topics covered:
* Accessing PSI elements
Expand All @@ -18,14 +18,14 @@ Topics covered:

## Technical requirements

Before starting this course, check the following requirements.
Before starting this course, please check the following requirements:

1. Your computer needs to have a stable internet connection.
2. Git version control system needs to be installed on your computer (link to the git site: https://git-scm.com/).
3. Make sure that the path to the root folder of the course does not contain spaces, special characters, or non-Latin characters.
4. Make sure that you use the [Intellij IDEA](https://www.jetbrains.com/idea/download/?_ga=2.189310830.494255415.1682514714-1823138827.1669894241&_gac=1.83806948.1682684894.Cj0KCQjw3a2iBhCFARIsAD4jQB3QkDU43KtbIx2HzEz02KvcN7Ma3QGzkIbyX4KS3H4x8b2bl9p4EfYaAvWsEALw_wcB&_gl=1*1h13lr8*_ga*MTgyMzEzODgyNy4xNjY5ODk0MjQx*_ga_9J976DJZ68*MTY4MjY5NDIyMy4xMjUuMS4xNjgyNjk0MjM4LjQ1LjAuMA..#section=windows) with version at least `2023.1.1`.
5. Make sure that you use the [JetBrains Academy](https://plugins.jetbrains.com/plugin/10081-jetbrains-academy) plugin with version at least `2023.1`.
1. Ensure that your computer has a stable internet connection.
2. Install the Git version control system on your computer (link to the Git site: https://git-scm.com/).
3. Ensure that the path to the root folder of the course does not contain spaces, special characters, or non-Latin characters.
4. Make sure you are using [IntelliJ IDEA](https://www.jetbrains.com/idea/download/?_ga=2.189310830.494255415.1682514714-1823138827.1669894241&_gac=1.83806948.1682684894.Cj0KCQjw3a2iBhCFARIsAD4jQB3QkDU43KtbIx2HzEz02KvcN7Ma3QGzkIbyX4KS3H4x8b2bl9p4EfYaAvWsEALw_wcB&_gl=1*1h13lr8*_ga*MTgyMzEzODgyNy4xNjY5ODk0MjQx*_ga_9J976DJZ68*MTY4MjY5NDIyMy4xMjUuMS4xNjgyNjk0MjM4LjQ1LjAuMA..#section=windows) with a version of at least `2023.1.1`.
5. Ensure that you are using the [JetBrains Academy](https://plugins.jetbrains.com/plugin/10081-jetbrains-academy) plugin with a version of at least `2023.1`.

The course is integrated into the [Intellij Idea IDE](https://www.jetbrains.com/idea/), which has a free Community license.
The course is integrated into the [IntelliJ IDEA IDE](https://www.jetbrains.com/idea/), which has a free Community license.
You can use this license to complete the course.
If you have some troubles with the course installation, feel free to contact us by email at [email protected].
If you encounter any issues with the course installation, feel free to contact us by email at [email protected].

0 comments on commit 67f7749

Please sign in to comment.