Skip to content

Commit d54951a

Browse files
authored
Merge pull request #10 from jetbrains-academy/stephen-hero-patch-6
Update README.md
2 parents f81a831 + 4940cbb commit d54951a

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
1212
**JetBrains Academy Kotlin course template** is a repository that provides a
1313
pure template to make it easier to create a new Kotlin course with the [JetBrains Academy
14-
plugin][ref:plugin.marketplace] (check the [Creating a repository from a template][gh:template] article).
14+
plugin][ref:plugin.marketplace] (check out the [Creating a repository from a template][gh:template] article).
1515

1616
The main goal of this template is to speed up the setup phase
17-
of a Kotlin course development for both new and experienced educators
17+
of Kotlin course development for both new and experienced educators
1818
by preconfiguring the project scaffold and CI,
1919
linking to the proper documentation pages, and keeping everything organized.
2020

@@ -41,21 +41,21 @@ In this README, we will highlight the following elements of template-project cre
4141
## Getting started
4242

4343
Before we dive into course development and everything related to it, it's worth mentioning the benefits of using GitHub Templates.
44-
By creating a new project using the current template, you start with no history or reference to this repository.
45-
This allows you to create a new repository easily without copying and pasting previous content, clone repositories, or clearing the history manually.
44+
By creating a new project with the current template, you start with no history or reference to this repository.
45+
This allows you to create a new repository easily, without copying and pasting previous content, cloning repositories, or clearing the history manually.
4646

47-
All you have to do is click the <kbd>Use this template</kbd> button (you must be logged in with your GitHub account).
47+
All you need to do is click the <kbd>Use this template</kbd> button (you must be logged in with your GitHub account).
4848

4949
![Use this template][file:use-template-blur]
5050

51-
The most convenient way for getting your new project from GitHub is the <kbd>Get from VCS</kbd> action available on the Welcome Screen,
51+
The most convenient way of getting your new project from GitHub is the <kbd>Get from VCS</kbd> action available on the Welcome Screen,
5252
where you can filter your GitHub repository by its name.
5353

5454
![Use this template][file:use-this-template.png]
5555

5656

57-
For the last step, you have to manually review the configuration variables described in the [`gradle.properties`][file:gradle.properties] file and *optionally* move sources from the *org.jetbrains.academy.kotlin.template* package to the one that works best for you.
58-
Then you can get to work implementing your ideas.
57+
As the last step, you need to manually review the configuration variables described in the [`gradle.properties`][file:gradle.properties] file and *optionally* move sources from the *org.jetbrains.academy.kotlin.template* package to the one that works best for you.
58+
Then you can get to work and implement your ideas.
5959

6060
## Gradle configuration
6161

@@ -76,7 +76,7 @@ The project-specific configuration file [`gradle.properties`][file:gradle.proper
7676
| `courseGroup` | Package name. |
7777
| `courseVersion` | The current version of the course in [SemVer][semver] format. |
7878
| `gradleVersion` | Version of Gradle used for course development. |
79-
| `jvmVersion` | Version of JVM used for course development. |
79+
| `jvmVersion` | Version of the JVM used for course development. |
8080

8181
## Course template structure
8282

@@ -133,7 +133,7 @@ A generated JetBrains Academy Kotlin Course Template repository contains the fol
133133

134134
## Course info configuration file
135135

136-
The course info configuration file is a [course-info.yaml][file:course-info.yaml] file located in the root directory.
136+
The course info configuration file is the [course-info.yaml][file:course-info.yaml] file located in the root directory.
137137
It provides general information about the course, like description, language, etc.
138138

139139
```yaml
@@ -150,67 +150,67 @@ environment_settings:
150150
151151
## Course ignore file
152152
153-
The course ignore file is a [.courseignore][file:courseignore] file located in the root directory.
153+
The course ignore file is the [.courseignore][file:courseignore] file located in the root directory.
154154
It provides the list of files or directories that will be ignored in the final course preview or archive.
155155
156156
```text
157157
README.md
158158
```
159159

160-
You can find more information about course preview in the [Course preview][ref:course.preview] section and
161-
about creating a course archive and uploading it to the marketplace in the [Course distribution][ref:course.distribution] section.
160+
You can find more information about the course preview in the [Course preview][ref:course.preview] section. Information
161+
about creating a course archive and uploading it to the marketplace is in the [Course distribution][ref:course.distribution] section.
162162

163163
## Sample code
164164

165-
The prepared template provides an example of a course with one section, two lessons and five tasks in total.
165+
The prepared template provides an example of a course with one section, two lessons, and five tasks in total.
166166

167167
![Course structure in the course creator mode][file:course-structure-author]
168168

169-
Each course might have unlimited number of sections, lessons, and tasks.
169+
Each course may have an unlimited number of sections, lessons, and tasks.
170170
Students will see almost the same course structure as the educator (course author):
171171

172172
![Course structure in the course student mode][file:course-structure-student]
173173

174-
The main difference is in framework lessons, that display
175-
only task files without intermediate steps.
174+
The main difference is in framework lessons, which display
175+
only task files, without intermediate steps.
176176

177177
You can read more about framework lessons in the official documentation in the [Framework Lessons Creation][ref:framework.lessons.creation] section.
178178

179179
> **Note**
180180
>
181-
> Click the <kbd>Course Creator</kbd> -> <kbd>Create Course Preview</kbd> in the context menu on the root of the repository to create a course preview.
181+
> Click <kbd>Course Creator</kbd> -> <kbd>Create Course Preview</kbd> in the context menu in the root of the repository to create a course preview.
182182
183183

184184
The JetBrains Academy plugin provides five different types of tasks,
185-
you can combine them inside one lesson (a regular or a framework one).
186-
You can read more about task in the official documentation in the [Task][ref:tasks] section.
185+
and you can combine them inside one lesson (whether regular or framework).
186+
You can read more about tasks in the official documentation in the [Task][ref:tasks] section.
187187

188188
## Testing
189189

190-
To check programming exercises for [**edu**][ref:tasks] tasks you need to write tests.
191-
This repository includes [Kotlin test framework][ref:kotlin.test.framework] to make the testing process easier.
190+
To check the programming exercises for [**edu**][ref:tasks] tasks, you need to write tests.
191+
This repository includes a [Kotlin test framework][ref:kotlin.test.framework] to make the testing process easier.
192192
It contains functionality to test student solutions by using the [Java Reflection API][ref:java.reflection.api] under the hood.
193-
This approach allows you to call students' functions which do not exist yet.
194-
It is a powerful mechanism to be able to create excesses without predefined classes or functions
193+
This approach allows you to call students' functions that do not exist yet.
194+
It is a powerful mechanism that enables you to create excesses without predefined classes or function
195195
templates and check their signature and behaviour properly.
196196

197-
You can find small examples in programming tasks in the repository in `Tests.kt` files:
198-
in the [course lesson][file:course.lesson.tests] and [course framework lesson][file:course.framework.lesson.tests].
197+
You can find little examples of programming tasks in the repository in the `Tests.kt` files:
198+
in [course lesson][file:course.lesson.tests] and [course framework lesson][file:course.framework.lesson.tests].
199199

200-
More examples of usage the [Kotlin test framework][ref:kotlin.test.framework] can be found in other Kotlin courses:
200+
More examples of using the [Kotlin test framework][ref:kotlin.test.framework] can be found in other Kotlin courses:
201201

202202
- [Kotlin Onboarding: Introduction][ref:kotlin.onboarding.introduction.marketplace] on [GitHub][ref:kotlin.onboarding.introduction.github]
203203
- [Kotlin Onboarding: Object-Oriented programming][ref:kotlin.onboarding.oop.marketplace] on [GitHub][ref:kotlin.onboarding.oop.github]
204204

205205
## Predefined Run/Debug configurations
206206

207-
Within the default project structure, there is a `.run` directory provided containing predefined *Run/Debug configurations* that expose corresponding Gradle tasks:
207+
Within the default project structure, there is a `.run` directory provided, which contains predefined *Run/Debug configurations* that expose corresponding Gradle tasks:
208208

209209
![Run/Debug configurations][file:run-debug-configurations]
210210

211211
| Configuration name | Description |
212212
|--------------------------|--------------------------------------------------------------------------------|
213-
| Build course | Runs `:build` Gradle task only with tests. |
213+
| Build course | Runs `:build` Gradle task with tests only. |
214214
| Build course with detekt | Runs `:build` Gradle task with tests and [Detekt][ref:detekt] static analysis. |
215215

216216
## Continuous integration
@@ -270,4 +270,4 @@ In the `.github/workflows` directory, you can find definitions for the following
270270
[file:course-structure-author]: common/src/main/resources/images/course-structure-author.png
271271
[file:course-structure-student]: common/src/main/resources/images/course-structure-student.png
272272
[file:run-debug-configurations]: common/src/main/resources/images/run-debug-configurations.png
273-
[file:use-template-blur]: common/src/main/resources/images/use_template_blur.jpg
273+
[file:use-template-blur]: common/src/main/resources/images/use_template_blur.jpg

0 commit comments

Comments
 (0)