Skip to content

Commit ebf1b86

Browse files
author
Artiom N.
committed
README errors fixed
1 parent 4768659 commit ebf1b86

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Docker образы тоже [могут потребовать обновлен
100100
Она представляет собой Docker-контейнер, образ которого [лежит на docker.hub](https://hub.docker.com/r/artiomn/nb-build-image).
101101
Сборка в ней запускается через скрипт `./build_dockerized.sh`.
102102

103-
Под Windows сборка была проверена на MSVS 2019 и собранные артефакты будут находиться в `src\out\build\windows-default\bin`.
103+
Под Windows сборка была проверена на MSVS 2019 bkb MSVS 2022, и собранные артефакты будут находиться в `src\out\build\windows-default\bin`.
104104
Собираться под Windows будет не всё, есть примеры только под Linux.
105105

106106
[К оглавлению ⮐](#%D0%BE%D0%B3%D0%BB%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5)
@@ -153,7 +153,7 @@ CMake Error: The source "/home/artiom/user/cpp-network-tasks/src/CMakeLists.txt"
153153
### Почему используется Linux?
154154

155155
- Потому что, на Linux и BSD системах работают большинство сетевых приложений.
156-
- На Linux работают авторы.
156+
- Linux используют авторы.
157157
- Кроме Linux есть множество других ОС, и рассмотреть особенности каждой невозможно.
158158
- Перевод кода на Windows оговорён.
159159
- По возможности, код и так кроссплатформенный.
@@ -162,7 +162,7 @@ CMake Error: The source "/home/artiom/user/cpp-network-tasks/src/CMakeLists.txt"
162162

163163
### Могу ли я собрать код на Windows?
164164

165-
Да, возможно собрать часть кода. Сборка проверялась на MS Visual Studio 2019.
165+
Да, возможно собрать часть кода. Сборка проверялась на MS Visual Studio 2019 и 2022.
166166
Подробнее о поддержке CMake в MSVS, вы можете [прочитать у Microsoft](https://github.com/MicrosoftDocs/cpp-docs/blob/main/docs/build/cmake-projects-in-visual-studio.md).
167167
Чтобы собрать код, надо открыть корневой CMakeLists.txt, как CMake проект.
168168

@@ -171,14 +171,12 @@ CMake Error: The source "/home/artiom/user/cpp-network-tasks/src/CMakeLists.txt"
171171
- Есть код специфичный для Linux, например перехватчик вызовов, который будет собираться и работать только на этой платформе.
172172
- Некоторый код просто не был адаптирован для Windows, и его сборка выключена.
173173
- Есть редкие примеры, которые собираются, но работать корректно не будут (один из таких - асинхронный сервер на `select()`).
174-
Оно не работает, потому что не было достаточно времени и мотивации, чтобы доработать под Windows.
175-
Если вы считаете, что можете доделать такой код - You're welcome.
176174
- В Windows есть не все библиотеки, а CMake не имеет, например модуля для поиска Qt, если Qt не установлен.
177175
Это приводит к тому, что пример не просто нельзя собрать, если чего-то не хватает, а падает сборка.
178176
Конечно, возможно это исправить, если вы считаете, что нужно, репозиторий открыт для правок.
179177
- Надо установить [Boost](https://sourceforge.net/projects/boost/files/boost-binaries/).
180178

181-
Также, есть некоторый код, специфичный для Windows, но в уроках он, как правило, не упоминается.
179+
Также, есть некоторый код, специфичный для Windows.
182180

183181
[К оглавлению ⮐](#%D0%BE%D0%B3%D0%BB%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5)
184182

@@ -201,10 +199,10 @@ CMake Error: The source "/home/artiom/user/cpp-network-tasks/src/CMakeLists.txt"
201199
Он позволяет изолировать приложения в контейнерах, образы которых скачаны из репозитория.
202200
Здесь он нужен для того, чтобы:
203201

204-
- Вы могли собрать код, не устанавливая лишних библиотек.
205-
- Вы могли проверить сборку тем же самым компилятором, что и проверяющий.
202+
- Вы могли собрать код, не устанавливая лишних библиотек в рабочую систему.
203+
- Вы могли проверить сборку тем же самым компилятором, что и авторы.
206204

207-
Напомню, что образ с инструкциями [лежит на Docker.hub](https://hub.docker.com/r/artiomn/nb-build-image).
205+
Напоминаем, что образ с инструкциями [лежит на Docker.hub](https://hub.docker.com/r/artiomn/nb-build-image).
208206

209207
[К оглавлению ⮐](#%D0%BE%D0%B3%D0%BB%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5)
210208

@@ -318,7 +316,7 @@ sys network power video storage lp input audio wheel artiom docker
318316
### Работая в Docker я не могу испортить систему?
319317

320318
Можете. Контейнер запускается в privileged режиме. Т.е. из него возможно создавать устройства, а значит испортить всё, что угодно.
321-
Это требуется для того, чтобы сети, в частности Yggdrasil, могли создать TUN устройство.
319+
Это требуется для того, чтобы сети могли создать TUN устройства.
322320

323321
[К оглавлению ⮐](#%D0%BE%D0%B3%D0%BB%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5)
324322

@@ -351,7 +349,7 @@ Receiving packet 1 from "google.com" response with id = 33, time = 160ms
351349
Есть два варианта:
352350

353351
- `./run`
354-
- `docker-compose run --rm gb` - для тех, кто пользуется docker-compose.
352+
- `docker-compose run --rm nb` - для тех, кто пользуется docker-compose.
355353

356354
**Обратите внимание:** консоль запускается через **скрипт `./run`** в корне репозитория, **не** через `docker run`.
357355

@@ -386,7 +384,7 @@ Windows Defender может заблокировать Netcat, определи
386384

387385
### Всё делаю правильно, но что-то не подключается
388386

389-
Такая проблема была у одного из студентов. Он выяснил, что Netcat подключался на IPv6 адрес, тогда как сервер прослушивал только IPv4.
387+
Такая проблема была у одного разработчика. Он выяснил, что Netcat подключался на IPv6 адрес, тогда как сервер прослушивал только IPv4.
390388
Как исправить? Зависит от приложения. Задайте ему не доменное имя, а IPv4 адрес явно, при возможности.
391389
Для Netcat возможно использовать опцию `-4` (не все реализации её поддерживают).
392390

@@ -400,12 +398,12 @@ Windows Defender может заблокировать Netcat, определи
400398
- Клонируете его, исправляете ошибку.
401399
- Делаете Pull request.
402400

403-
Или просто можете просто завести [Issue](https://github.com/artiomn/cpp-network-tasks/issues/new/choose).
404-
Но, в этом случае, обещать быстрое исправление я не могу.
401+
Или просто можете просто завести [Issue](https://github.com/artiomn/network-programming-book-code/issues/new/choose).
402+
Но, в этом случае, обещать быстрое исправление мы не можем.
405403

406404
[К оглавлению ⮐](#%D0%BE%D0%B3%D0%BB%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5)
407405

408-
## Для контрибьютеров
406+
## Для контрибьюторов
409407

410408
В корневой директории имеется скрипт `install_git_hooks.py`, данный скрипт проверяет наличие установленного инструмента pre-commit, и, если его нет, устанавливает его. pre-commit - это инструмент для автоматизации проверок и тестов перед фиксацией (коммитом) изменений в репозитории Git. Он позволяет определить набор проверок и скриптов, которые должны быть выполнены перед тем, как изменения будут зафиксированы в репозитории. Использование pre-commit помогает поддерживать качество кода, уменьшает вероятность внесения ошибок и упрощает совместную работу.
411409

@@ -418,10 +416,10 @@ pip3 install pre-commit
418416
После чего перейти в корневой репозиторий `network-programming-book-code` и ввести команду:
419417

420418
```cmd
421-
pre-commit install --install-hooks
419+
pre-commit install --install-hooks
422420
```
423421

424-
Затем
422+
Затем:
425423

426424
```cmd
427425
pre-commit run

0 commit comments

Comments
 (0)