More rewrites and some .md formatting

Author: WoWaster

README.en.md

@@ -3,18 +3,18 @@
 ---
 # Formal Language Course
 
-A course on formal languages: repository structure template for completing homework assignments, as well as course materials and other related information.
+A course on formal languages: repository template for completing homework assignments, as well as course materials and other related information.
 
-Current:
-- [List of tasks](https://github.com/FormalLanguageConstrainedPathQuerying/formal-lang-course/blob/main/tasks.en.md)
+Useful links:
+- [List of exercises](https://github.com/FormalLanguageConstrainedPathQuerying/formal-lang-course/blob/main/tasks.en.md)
 - [Code style reference](https://www.python.org/dev/peps/pep-0008/)
 - [On reachability with constraints in terms of formal languages, in Russian](https://github.com/FormalLanguageConstrainedPathQuerying/FormalLanguageConstrainedReachability-LectureNotes)
-- A classic textbook on parsing algorithms: [Dick Grune, Ceriel J. H. Jacobs, "Parsing Techniques A Practical Guide"](https://link.springer.com/book/10.1007/978-0-387-68954-8#bibliographic-information)
-- A classic textbook on formal language theory: [M. A. Harrison. 1978. "Introduction to Formal Language Theory"](https://dl.acm.org/doi/book/10.5555/578595)
+- A textbook on parsing algorithms: [Dick Grune, Ceriel J. H. Jacobs, "Parsing Techniques A Practical Guide"](https://link.springer.com/book/10.1007/978-0-387-68954-8#bibliographic-information)
+- A textbook on formal language theory: [M. A. Harrison. 1978. "Introduction to Formal Language Theory"](https://dl.acm.org/doi/book/10.5555/578595)
 - Recent work on automata theory and its applications in various fields: [Editors: Jean-Éric Pin. 2021. "Handbook of Automata Theory"](https://ems.press/books/standalone/172)
 - [Tool for constructing and simulating various recognizers](https://github.com/spbu-se/KotlinAutomataConstructor)
 
-Technologies:
+Technology stack:
 - Python 3.12
 - Pytest for unit testing
 - GitHub Actions for CI
@@ -26,37 +26,37 @@ Technologies:
 
 - [Formal Language Course](#formal-language-course)
   - [Table of contents](#table-of-contents)
-  - [Marks computation](#marks-computation)
+  - [Grading](#grading)
     - [Tests](#tests)
-    - [Homework Practical Tasks](#homework-practical-tasks)
+    - [Exercises](#exercises)
   - [Working with the Project](#working-with-the-project)
-  - [Homework Practical Tasks](#homework-practical-tasks-1)
-    - [Completing Homework](#completing-homework)
+  - [Homework](#homework)
+    - [Completing homework](#completing-homework)
     - [Получение оценки за домашнюю работу](#получение-оценки-за-домашнюю-работу)
-  - [Code](#code)
-  - [Tests](#tests-1)
+  - [Code style](#code-style)
+  - [Tests and Autotests](#tests-and-autotests)
   - [Experiments](#experiments)
   - [Repository Structure](#repository-structure)
   - [Course developers](#course-developers)
   - [Вместо введения](#вместо-введения)
 
-## Marks computation
+## Grading
 
 The grade for the course is based on the points earned throughout the semester.
 Points are awarded for the following:
-- Homework assignments (points for each task are specified separately).
-- Tests (short, 5-10 minute control tasks).
-A test is graded from 0 to 1 points.
-Points from tests are used to weigh the points for homework assignments.
+- Exercises (points for each task are specified separately).
+- Tests (short, 5-10 minute assessment).
+  A test is graded from 0 to 1 points.
+  Points from tests are used to weigh the points for exercises.
 - Additional tasks assigned by the instructor, such as preparing course materials, implementing demonstration algorithms, etc.
-These are graded at the instructor's discretion, but no more than 30 points in total can be awarded.
+  These are graded at the instructor's discretion, but no more than 30 points in total can be awarded.
 
 __TODO: первое предложение бредовое слегка и на русском. Надо поправить и там, и там__
 
 The final grade for the course is a weighted sum of the points for tasks and additional assignments, where the weight is the points for the nearest tests (chronologically speaking) to the right.
-One can think of the course as divided into blocks, where each block contains some tasks and a test that will weigh those tasks.
-For example, suppose there are two blocks, each with 2 tasks and 2 tests.
-Let's say the first two tasks earned 4 and 5 points, and the remaining two earned 2.5 and 3 points respectively. For the first test, the score is 0.25 points, and for the second test, it is 0.75 points.
+One can think of the course as divided into blocks, where each block contains some exercises and a test that will weigh those exercises.
+For example, suppose there are two blocks, each with 2 exercises and 2 tests.
+Let's say the first two exercises earned 4 and 5 points, and the remaining two earned 2.5 and 3 points respectively. For the first test, the score is 0.25 points, and for the second test, it is 0.75 points.
 Then, the final grade for the course would be:
 $(4 + 5) * 0.25 + (2.5 + 3) * 0.75 = 6.375$.
 
@@ -75,7 +75,7 @@ __TODO: Подумать надо ли как-то поменять таблич
 
 ### Tests
 
-A "test" is a small control task (lasting 5-10 minutes) that is written during a class (usually at the beginning).
+A "test" is a small assessment (lasting 5-10 minutes) that is written during a class (usually at the beginning).
 The typical number of tests during a course is 2-3.
 During the test, students can use any materials, but the time limit is strictly enforced.
 Tests can be rewritten (rewrites are usually centralized at the end of the semester), but with each rewrite, the maximum possible score for the test is halved.
@@ -86,23 +86,23 @@ Typical test questions:
 - Construct a leftmost derivation of this string in this grammar.
 - Build a finite automaton that represents the same language as this regular expression.
 - What is the space complexity of algorithm X?
-- Give the definition of a recursive finite automaton.
+- Give the definition of a RSM.
 - What is the difference between CNF and wCNF?
 
-### Homework Practical Tasks
+### Exercises
 
-There are two types of tasks:
-- Tasks with fully automated grading.
-These tasks have known function names, signatures, and a set of test cases; if the tests pass, the task is considered completed.
-The number of points for such tasks is at least 60.
-This means that by completing all tests and submitting all such tasks, you can guarantee a grade of 3 (E-D) for the course.
-- Tasks requiring evaluation by the instructor or assistant.
-These are typically tasks that involve setting up experiments or developing relatively non-trivial solutions.
-They are based on tasks of the previous type, so solving them in isolation can be difficult.
+There are two types of exercises:
+- **Exercises with fully automated grading.**
+  These exercises have known function names, signatures, and a set of test cases; if the tests pass, the task is considered completed.
+  The number of points for such exercises is at least 60.
+  This means that by completing all tests and submitting all such exercises, you can guarantee a grade of 3 (E-D) for the course.
+- **Exercises requiring evaluation by the instructor or assistant.**
+  These are typically exercises that involve setting up experiments or developing relatively non-trivial solutions.
+  They are based on exercises of the previous type, so solving them in isolation can be difficult.
 
 ## Working with the Project
 
-- To complete the homework practical tasks, you need to fork this repository to your GitHub account.
+- To complete the exercises, you need to fork this repository to your GitHub account.
 - It is recommended to install [`pre-commit`](https://pre-commit.com/#install) to keep the project in good condition.
   - You can install `pre-commit` by running the following command in the root of your project:
     ```shell
@@ -115,42 +115,42 @@ They are based on tasks of the previous type, so solving them in isolation can b
 - Share the link to your fork of the repository with the instructor for it to be added to the results table.
 - You need to add reviewers to your repository with `admin` rights for reading, editing, and reviewing pull requests.
 
-## Homework Practical Tasks
+## Homework
 
-All tasks have a deadline (usually one week from when they are assigned), after which the maximum score for the task is halved.
+All exercises have a deadline (usually one week from when they are assigned), after which the maximum score for the task is halved.
 
 The number of reviews is limited to three.
-A review request is considered a check attempt.
+Requesting a review counts as an attempt to submit assignment.
 After three attempts, the points for the task are lost.
 The first review request must be made **before the deadline**.
 **Note**, there should be no commits between the review request and the actual review.
-This means you should ensure everything is ready before requesting a review.
+This means you must ensure everything is ready before requesting a review.
 If there are commits after the request and before the review, the points for the task will be halved permanently.
 
-Please note that if a review is requested but not all requirements for the solution are met (e.g., CI fails, not all parts of the task are completed, not all questions are answered, or report requirements are not followed), a detailed review of the task will not be conducted, and the attempt will be considered failed.
+Please note that if a review is requested but not all requirements for the solution are met (e.g., CI fails, not all parts of the task are completed, not all questions are answered, or requirements for the reports are not followed), a detailed review of the task will not be conducted, and the attempt will be considered failed.
 In such a case, the only feedback you may receive is something like "the task is not fully completed".
 Therefore, completing the task properly is the responsibility of the student.
 
-### Completing Homework
+### Completing homework
 
-When working on the homework, you must follow the GitHub Flow ([more info here](https://githubflow.github.io/) and [here](https://habr.com/ru/articles/346066/)).
+When working on the homework, you must follow the GitHub Flow ([more info here](https://githubflow.github.io/) and [here (in Russian)](https://habr.com/ru/articles/346066/)).
 
 Additionally, keep the following points in mind:
 - Each homework assignment should be completed in a separate branch.
-The branch should have a meaningful and consistent name.
+  The branch should have a meaningful and consistent name.
 - The branch should only contain commits made by the person submitting the task, and only those commits that directly relate to solving the task.
 - The filename should reflect its content (e.g., the name of the algorithm).
 - Automatic tests should not be modified, except in cases explicitly mentioned in the task description.
-- Commit messages should be clear and reflect the essence of what was done.
+- Commit messages should be clear and reflect commit content.
 - When completing homework in a new branch, you must open a corresponding pull request to the `main` branch of your fork.
 - Note that all tests must pass, not just those related to the task being submitted in the current pull request.
 - The pull request should have a clear title and description with relevant progress points.
 - The task will be reviewed through the review of your pull request (by filling in the Reviewers field).
-Even if the task doesn't require instructor verification, a review request must still be made.
+  Even if the task doesn't require instructor verification, a review request must still be made.
 - Once you believe the task is complete, you can request a review from the reviewer.
   - To earn full points for the task, the review must be requested **before the deadline**.
 - When the review is complete and the task is **approved**, it must be merged into the `main` branch of your fork.
-- The results of completed tasks will be reused in subsequent homework assignments.
+- The results of completed exercises will be reused in subsequent homework assignments.
 
 ### Получение оценки за домашнюю работу
 
@@ -164,18 +164,18 @@ __TODO: Здесь вроде что-то надо было чинить, так
   - Если исчерпано количество попыток сдать задачу (больше трёх), то за неё получаете **0 баллов**.
 - Если после запроса ревью и до самого ревью в ветку были ещё коммиты, то за задачу можно получить **максимум половину баллов**. То есть в предыдущих пунктах заменяем **полный балл** на **половину полного балла**.
 
-## Code
+## Code style
 
-- Place the source code for programming tasks in the `project` folder.
+- Place the source code for programming exercises in the `project` folder.
 - Give files and modules meaningful names, following the officially accepted style.
 - Structure the code by using both classes and well-defined functions.
-The clearer the code, the faster it can be reviewed, and the more likely you are to receive full points.
+  The clearer the code, the faster it can be reviewed, and the more likely you are to receive full points.
 
-## Tests
+## Tests and Autotests
 
 There are two types of tests: those prepared by the instructor and your own.
 
-The instructor-prepared tests are located in the `tests/autotests` folder and are used to check tasks with fully automated grading.
+The instructor-prepared tests are located in the `tests/autotests` folder and are used to check exercises with fully automated grading.
 When working with these tests, the following rules should be followed:
 
 - In these tests, usually, only one block should be modified:
@@ -186,15 +186,15 @@ When working with these tests, the following rules should be followed:
       pytestmark = pytest.mark.skip("Task 2 is not ready to test!")
   ```
   In this block, you need to specify from which module(s) the required functions should be imported; otherwise, the tests will be skipped.
-- If you find a bug **and** are ready to fix it, you can modify the file and then submit the change via a Pull Request to the main repository.
-- If you find a bug and are not ready to fix it, you must urgently inform the instructor and take no further action!
+- If you find a bug **and** are willing to fix it, you can modify the file and then submit the change via a Pull Request to the main repository.
+- If you find a bug and are not willing to fix it, you must inform the instructor and take no further action!
 
 The following rules apply to your own tests:
 
 - Place tests for homework assignments in the `tests` folder.
 - The naming format for test files is `test_[module/class/function being tested].py`.
 - Use [`pytest`](https://docs.pytest.org/en/6.2.x/) to work with tests.
-- To run the tests, you need to execute the following command from the root of the project:
+- To run the tests, use the following command from the root of the project:
   ```shell
   python ./scripts/run_tests.py
   ```
@@ -203,10 +203,10 @@ The following rules apply to your own tests:
 
 An experiment (setup, measurements, results, analysis of results) should be documented as a Python notebook, which is published on GitHub.
 - To perform experiments, you will need not only the code but also the environment and some configuration.
-Accordingly, the solution submitted should include instructions for setting up the environment and reproducing the experiments.
-Ideally, all of this should be included in the notebook.
+  Accordingly, the solution submitted should include instructions for setting up the environment and reproducing the experiments.
+  Ideally, all of this should be included in the notebook.
 - Experiments should be reproducible (e.g., by reviewers).
-- The notebook contains all the setup, code for the experiments, preparation of reports, and creation of graphs.
+- The notebook must contain the setup, code for the experiments, preparation of reports, and creation of graphs.
 - The notebook serves as a connected narrative describing the goals of the experiment, the methodology, analysis of the results, and answers to the questions posed.
   - The answers to the questions must be substantiated (by experiments), the observed behavior should be analyzed and justified.
 
@@ -220,13 +220,13 @@ Ideally, all of this should be included in the notebook.
 ├── scripts - helper scripts for automating development
 ├── tests - directory for unit tests of homework assignments
 │   └── autotests - directory with automated tests for homework assignments
-├── pyproject.toml - dependencies for repository setup
-├── README.md - main information about the project
-└── tasks.md - file with descriptions of homework assignments
+├── pyproject.toml - dependencies for repository
+├── README.en.md - main information about the project (in English)
+├── README.md - main information about the project (in Russian)
+├── tasks.em.md - file with descriptions of homework assignments (in English)
+└── tasks.md - file with descriptions of homework assignments (in Russian)
 ```
 
-__TODO: вот здесь русскую или английскую версию файлов лучше указать?__
-
 ## Course developers
 
 - Semyon Grigorev [@gsvgit](https://github.com/gsvgit)

README.md

@@ -3,6 +3,9 @@
 ---
 # Formal Language Course
 
+> [!NOTE]
+> English version of the README can be found in [README.en.md](README.en.md).
+
 Курс по формальным языкам: шаблон структуры репозитория для выполнения домашних работ,
 а также материалы курса и другая сопутствующая информация.