Merge pull request #17 from webtime-studio/fix/update-readme

Обновляет и улучшает структуру проекта в ридми, делает её идентичной …

Author: tinakuzmenko

README.md

@@ -21,31 +21,71 @@
 ## Файловая структура
 
 ```
-source/
-  fonts/                - папка с подключаемыми шрифтами
-  html/                 – HTML
-    includes/           – блоки
-    views/              – страницы
-  img/                  - картинки
-  js/                   - JavaScript
-  root/                 - файлы, которые будут лежать в корне проекта
-    manifest.json       - базовая информация о сайте для браузера 
-  scss/                 - стили
-    blocks/             – блоки
-    font-face.scss      - подключение шрифтов
-    global.scss         - глобальные стили
-    style.scss          - подключение всех стилей проекта
-    variables.scss      - SCSS переменные (цвета, размеры, шрифты)
-  vendors/
-    normalize-css/
-      normalize.min.css - нормализация стилей по умолчанию
-webpack/
-  webpack.config.js     - конфиг для webpack
-.editorconfig           - настройки редактора кода
-.eslitrc.js             - настройки JS линтера
-.gitignore              - файлы игнорируемые Git
-.prettierrc             - настройки Prettier
-.stylelintrc.js         - настройки Stylelint
+myApp
+├── .github
+│   ├── bug_report.md                - шаблон для создания issue
+│   └── feature_request.md           - шаблон для создания запроса на улучшение
+│
+├── source                           - все основные файлы, которые вам нужны
+│   ├── fonts                        - папка с подключаемыми шрифтами
+│   │   ├── Roboto-Regular.woff      – шрифт старого формата
+│   │   └── Roboto-Regular.woff2     – шрифт более современного формата
+│   │
+│   ├── html                         – HTML компоненты сайта
+│   │   ├── includes/                – блоки
+│   │   │   ├── common               - папка с переиспользуемыми блоками
+│   │   │   │   ├── footer.html      - футер сайта
+│   │   │   │   └── header.html      - хедер сайта
+│   │   │   │
+│   │   │   └── index                - папка блоков для страницы views/index.html
+│   │   │       ├── hero.html        - секция hero
+│   │   │       └── structure.html   - секция structure
+│   │   │
+│   │   └── views/                   – страницы
+│   │       └── index.html           - главная (корневая) страница сайта
+│   │
+│   ├── img                          - графика
+│   │   └── logo.svg                 - лого проекта
+│   │
+│   ├── js                           - скрипты сайта
+│   │   └── index.js                 - точка входа для скриптов
+│   │   └── script.js                - пример импортируемого модуля
+│   │
+│   ├── root                         - файлы, которые будут лежать в корне проекта
+│   │   └── manifest.json            - базовая информация о сайте для браузера
+│   │
+│   ├── scss                         - стили проекта
+│   │   ├── blocks                   - примеры стилей вынесенных в блоки
+│   │   │   ├── container.scss       - стили для .container
+│   │   │   ├── header.scss          - стили для .header
+│   │   │   ├── logo.scss            - стили для .logo
+│   │   │   ├── nav.scss             - стили для .nav
+│   │   │   └── visually-hidden.scss - этот блок используется для того, чтобы доступно прятать контент на странице.
+│   │   │
+│   │   ├── font-face.scss           - подключение шрифтов
+│   │   ├── global.scss              - глобальные стили
+│   │   ├── style.scss               – точка входа для стилей проекта
+│   │   └── variables.scss           - переменные (цвета, размеры, шрифты и т.п.)
+│   │
+│   └── vendors                      - папка для внешних скриптов и библиотек
+│       └── normalize-css/           - нормализация стилей по умолчанию (https://necolas.github.io/normalize.css/)
+│           └── normalize.min.css    - минифицированный файл
+│
+├── webpack                          - папка для конфигураций webpack 
+│   └── webpack.config.js            - конфиг для webpack
+│
+├── .editorconfig                    - настройки для редактора кода
+├── .eslintrc.js                     - настройки для линтера JS (ESLint)
+├── .gitattributes                   - технический файл для Git
+├── .gitignore                       - файлы/папки игнорируемые Git
+├── .prettierrc                      - настройки форматирования кода (Prettier)
+├── .stylelintrc.js                  - настройки для линтера SCSS (Stylelint)
+├── LICENSE                          - лицензия проекта (MIT)
+├── package.json                     - зависимости, скрипты и базовая информация
+└── README.md                        - описание проекта
+
+* Обратите внимание! Мы не добавляли в проект файлы package-lock.json и yarn.lock, 
+так как они будут сгенерированы автоматически во время установки проекта.
 ```
 
 ## Зависимости