From 155cde44f8ff9b68563723bf257af4a38271cd0e Mon Sep 17 00:00:00 2001 From: Aleksey Zubakov Date: Thu, 13 Oct 2022 16:52:31 +0300 Subject: [PATCH] Fix up and rewrite README.md a bit --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 9297913..3c1fb92 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,23 @@ Репозиторий для материалов курса. -Для зачёта необходимо выполнить набор относительно несложных действий, см. [Что обязательно сделать](#что-обязательно-сделать). +**Зачёт:** Для зачёта необходимо выполнить набор относительно несложных действий, _см. +**[Что обязательно +сделать](#что-обязательно-сделать)**_. -В файле [local_instruction.md](./local_instruction.md) можно найти инструкцию -как локально (на Вашем пк) поднять базу данных и админку [pgAdmin][pgadmin] -с помощью [docker]. +## Как поднять PostgreSQL у себя на компьютере + +В файле **[local_instruction.md](./local_instruction.md)** можно найти инструкцию +как локально (на Вашем пк) поднять базу данных и админку **[pgAdmin][pgadmin]** +с помощью **[docker]**. ## Что обязательно сделать -0. _Пока_ пытаться нарешивать задачки с [sql-ex.ru], все нарешанные +0. _Пока_ пытаться нарешивать задачки с **[sql-ex.ru]**, все нарешанные Вами задания обязательно будут зачтены. -1. Разбиться на команды по 3-5 человек и заполнить [форму][form]. -2. Выбрать тему для проекта cм.: [Как выбрать тему](#как-выбрать-тему)) -3. Написать отчёт (см. [Требования к отчёту](#требования-к-отчёту)). +1. Разбиться на команды по 3-5 человек и заполнить **[форму][form]**. +2. Выбрать тему для проекта (_cм.: **[Как выбрать тему](#как-выбрать-тему)**_) +3. Написать отчёт (_см. **[Требования к отчёту](#требования-к-отчёту)**_). 4. Прислать его нам. 5. Прийти на пару в ноябре-декабре, чтобы: - показать нарешанные задания; @@ -37,7 +41,7 @@ - база данных сайта простого банковского приложения; - база данных частной школы; - база данных отдельного аэропорта; -- больше тем здесь: _[список тем прошлого года]_. +- больше тем здесь: **[список тем прошлого года]**. ## Требования к отчёту @@ -50,7 +54,7 @@ т.к. в далнейшем это лучше выразить в виде типа для колонки таблицы (1-5 предложений и/или списочек требований). -_Пример:_ условный аэропорт, для которого мы пишем БД, требует какие-нибудь +**Пример:** условный аэропорт, для которого мы пишем БД, требует какие-нибудь личные данные для брони места в самолёте (ну, например, ФИО) -- это стоит зафиксировать текстом, позже можно выразить в виде трёх обязательных текстовых полей в таблице с бронированиями. @@ -59,20 +63,20 @@ _Пример:_ условный аэропорт, для которого мы у каждой из таблиц, опишите это текстом (до несколких абзацев по 2-5 предложений). -Обязательно укажите тип каждого столбца ([какая-то шпаргарклка по типам в PostgreSQL][postgre-cheat]) и, -если есть, дополнительные ограничения ([документация возможных ограничений в PostgreSQL][constraints]). +Обязательно укажите тип каждого столбца (**[какая-то шпаргарклка по типам в PostgreSQL][postgre-cheat]**) и, +если есть, дополнительные ограничения (**[документация возможных ограничений в PostgreSQL][constraints]**). -Поймите какие ключи (primary и foreign) есть в ваших таблицах, отразите +Поймите какие ключи (**primary**/**foreign**) есть в ваших таблицах, отразите это на диаграмме и/или в тексте. Усердствовать с количеством таблиц и полей не нужно, достаточно 4-7 таблиц по 2-7 поля (столбца?) в каждой. -Нарисуйте диаграмму вашей БД, например, с помощью [drawsql], добавьте схему +Нарисуйте диаграмму вашей БД, например, с помощью **[drawsql]**, добавьте схему в отчёт. ### Оформление - - **один (!)** файл формата [pdf] (обычно в таком формате умеют экспортировать почти + - **один (!)** файл формата **[pdf]** (обычно в таком формате умеют экспортировать почти все редакторы); - в отчёте должно быть **1 или несколько** непустых страниц; - текст должен занимать не менее двух третей страницы;