Merge pull request PanovaElena#10 from UNN-VMK-Software/readme-fixes

Readme and docs fixes

README.md

@@ -24,7 +24,7 @@ __Цель данной работы__  — разработка структу
 Выполнение работы предполагает решение следующих задач:
 
   1. Реализация класса битового поля `TBitField` согласно заданному интерфейсу.
-  1. Реализация класса множества `TSet` согласну заданному интерфейсу.
+  1. Реализация класса множества `TSet` согласно заданному интерфейсу.
   1. Обеспечение работоспособности тестов и примера использования.
 
 ## Используемые инструменты
@@ -38,7 +38,7 @@ __Цель данной работы__  — разработка структу
   - Среда разработки Microsoft Visual Studio (2008 или старше).
   - Опционально. Утилита [CMake](http://www.cmake.org) для генерации проектов по
     сборке исходных кодов. Она может быть использована для генерации решения для
-    среды разработки, отличной от Microsoft Visual Studio.
+    среды разработки, отличной от Microsoft Visual Studio 2008 или 2010, предоставленных в данном проекте-шаблоне.
 
 ## Общая структура проекта
 
@@ -48,7 +48,7 @@ __Цель данной работы__  — разработка структу
   - `gtest` — библиотека Google Test.
   - `include` — директория для размещения заголовочных файлов.
   - `samples` — директория для размещения демо-приложений.
-  - `sln` — директория с файлами решений и проектов для VS 2008 и VS2010,
+  - `sln` — директория с файлами решений и проектов для VS 2008 и VS 2010,
     вложенные директории `vc9` и `vc10` соответственно.
   - `src` — директория с исходными кодами (cpp-файлы).
   - `test` — директория с модульными тестами и основным приложением,
@@ -83,14 +83,14 @@ __Цель данной работы__  — разработка структу
 
 ## Инструкция по выполнению работы
 
-Предполагается выполнение лабораторной работы в несколько шагов:
+Выполнение лабораторной работы предполагается в несколько шагов:
 
   1. Освоение общих принципов работы с Git и GitHub. Последовательность
-     действий, которую необходимо выполнить, описана перед началом работы с
+     действий, которую необходимо выполнить перед началом работы с
      проектом, описана в документе, посвященному [Git][git-guide].
   1. Освоение общих принципов работы с Google Test. Инструкции приведены в
      разделе, посвященному [Google Test][gtest-guide].
-  1. Создание полноценной реализации классов `TBitField` и `TSet`, проходящих
+  1. Создание полноценных реализаций классов `TBitField` и `TSet`, проходящих
      все автоматические тесты.
 
 <!-- LINKS -->

docs/part1-git.md

@@ -23,9 +23,11 @@
   1. Создать аккаунт на [github.com](https://github.com), если такой
      отсутствует. Для определенности обозначим аккаунт `GITHUB-ACCOUNT`.
 
+  1. Открыть в браузере репозиторий по адресу <https://github.com/UNN-VMK-Software/mp2-lab1-set>.
+
   1. Сделать fork [репозитория][upstream] c проектом-шаблоном (в терминологии
      Git `upstream`-репозиторий) к себе в личный профиль с названием
-     `GITHUB-ACCOUNT`. В результате будет создана копия репозитория с названием
+     `GITHUB-ACCOUNT` (см. одноименную кнопку на странице репозитория). В результате будет создана копия репозитория с названием
      <https://github.com/github-account/mp2-lab1-set> (`origin`-репозиторий).
 
   1. Клонировать `origin` репозиторий к себе на локальный компьютер,
@@ -43,6 +45,28 @@
 
 ## Внесение изменений, их регистрация и публикация
 
+Когда сделан fork репозитория, по умолчанию у вас создается единственная ветка master. При решении независимых задач следует создавать рабочие ветки.
+
+  1. Получить список веток:
+
+  ```bash
+  $ git branch [-v]
+  # [-v] - список с информацией о последних коммитах
+  ```
+
+  1. Создать ветку:
+
+  ```bash
+  $ git branch bitfield-implementation
+  ```
+
+  1. Создать ветку bitfield-implementation и перейти в нее:
+
+  ```bash
+  $ git checkout [-b] bitfield-implementation
+  # [-b] - создание и переход в ветку <branch_name>
+  ```
+
 При работе с файлами в ветке необходимо управлять изменениями. Далее приведен
 перечень основных команд в предположении, что текущей рабочей веткой
 является `master`.

docs/part2-google-test.md

@@ -14,7 +14,7 @@
     - `sample_prime_numbers` -- пример реализации алгоритма поиска простых чисел
       "Решето Эратосфена". Обратите внимание, что файл содержит две реализации
       алгоритма, первая использует класс битового поля, вторая -- класс множества.
-      Текущая компилируемая версия основной функции зависит, объявлена ли
+      Текущая компилируемая версия основной функции зависит от того, объявлена ли
       переменная `USE_SET` или нет (строка кода `#define USE_SET`). Реализация
       алгоритма также не требует модификации.
     - `bitfield` -- статическая библиотека, содержащая модули `tbitfield` и `tset`.
@@ -35,28 +35,30 @@
   1. Последовательно реализуйте конструкторы, операции вставки/удаления,
      перегруженные операции класса `TBitField`.
      - После реализации каждого метода пересобирайте решение и запускайте тесты,
-       чтобы отслежить корректность исполнения тестов для реализуемого метода.
-     - Когда вы убедились, что метод работает корректно необходимо зафиксировать
+       чтобы отследить корректность исполнения тестов для реализуемого метода.
+     - Когда вы убедились, что метод работает корректно, необходимо зафиксировать
        изменения в локальном репозитории (команды `git add` и `git commit`,
-       подробнее в разделе [Общие инструкции по работе с Git][git-instructions]).
-  1. После того, как вы убедились, что ВСЕ тесты для класса битового поля
+       подробнее в разделе [Инструкции по работе с Git][git-guide]).
+  1. После того, как вы убедились, что ВСЕ тесты для класса битовое поле
      отрабатывают корректно, запустите приложение `sample_prime_numbers.exe`
      и проверьте его работоспособность для битовых полей (директива
      `#define USE_SET` должна быть закомментирована).
   1. Последовательно реализуйте конструкторы, операции вставки/удаления,
      перегруженные операции класса `TSet`.
      - После реализации каждого метода пересобирайте решение и запускайте тесты,
-       чтобы отслежить корректность исполнения тестов для реализуемого метода.
-     - Когда вы убедились, что метод работает корректно необходимо зафиксировать
+       чтобы отследить корректность исполнения тестов для реализуемого метода.
+     - Когда вы убедились, что метод работает корректно, необходимо зафиксировать
        изменения в локальном репозитории (команды `git add` и `git commit`,
-       подробнее в разделе [Общие инструкции по работе с Git][git-instructions]).
-  1. После того, как вы убедились, что ВСЕ тесты для класса битового поля
+       подробнее в разделе [Инструкции по работе с Git][git-guide]).
+  1. После того, как вы убедились, что ВСЕ тесты для класса множество
      отрабатывают корректно, запустите приложение `sample_prime_numbers.exe`
-     и проверьте его работоспособность для битовых полей (директива
+     и проверьте его работоспособность для множества (директива
      `#define USE_SET` должна быть раскомментирована).
   1. Чтобы обеспечить возможность удаленной проверки работы (включая
      автоматический запуск и проверку корректности тестов), необходимо
      создать Pull Request в upstream-репозиторий. Подробнее, как создать
-     Pull Request, в разделе [Общие инструкции по работе с Git][git-instructions].
+     Pull Request, в разделе [Инструкции по работе с Git][git-guide].
+
+<!-- LINKS -->
 
 [git-guide]:   https://github.com/UNN-VMK-Software/mp2-lab1-set/blob/master/docs/part1-git.md