From 2b7affc0728e5dc1c5aca805703b388c2a5fbcef Mon Sep 17 00:00:00 2001 From: Alexander Repeta <alexander.repeta@gmail.com> Date: Mon, 15 Mar 2021 13:29:52 +0200 Subject: [PATCH] update readme --- README.md | 57 +++++++++++++------------------------------------------ 1 file changed, 13 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index f673903..f631975 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,21 @@ # parcel-project-template -## Developing +## Зависимости -### Prerequisites +На компьютере должена быть установлена LTS-версия +[Node.js](https://nodejs.org/en/). -На компьютере должен быть установлен [Node.js](https://nodejs.org/en/). - -Для корректной работы SASS-компилятора и других инструментов, необходимо один -раз глобально поставить дополнительные пакеты, выполнив в терминале следующие -команды. Пользователям MacOS ничего делать не нужно. - -Пользователям **Windows**, в режиме администратора. -[Как запусттить Powershell](https://youtu.be/p2tFnxcymwk) в режиме -администратора. - -```shell -npm install --global --production windows-build-tools -``` - -Вот как выглядит процесс успешной установки для пользователей **Windows**. - - - -Пользователям **Linux**. - -```shell -sudo apt-get install gcc g++ make -``` - -### Setting up Dev +## Перед началом работы Один раз на проект установить все зависимости. ```shell -npm install +npm ci ``` -И запустить режим разработки. +### Разработка + +Запустить режим разработки. ```shell npm run dev @@ -45,17 +24,7 @@ npm run dev Во вкладке браузера перейти по адресу [http://localhost:1234](http://localhost:1234). -### Building - -Для того чтобы создать оптимизированные файлы для хостинга, необходимо выполнить -следующую команду. В корне проекта появится папка `build` со всеми -оптимизированными ресурсами. - -```shell -npm run build -``` - -### Deploying / Publishing +### Деплой Сборка может автоматически деплоить билд на GitHub Pages удаленного (remote) репозитория. Для этого необходимо в файле `package.json` отредактировать поле @@ -83,11 +52,11 @@ npm run deploy страницу можно будет посмотреть по адресу указанному в отредактированном свойстве `homepage`. -## Configuration +## Файлы и папкм - Все паршалы файлов стилей должны лежать в папке `src/sass` и импортироваться в `src/sass/main.scss` - Изображения добавляйте в папку `src/images`, заранее оптимизировав их. Сборщик - просто копирует используемые изображения чтобы не нагружать вашу систему - оптимизацией десятков картинок, так как на слабых компьютерах это повесит - систему. + просто копирует используемые изображения чтобы не нагружать систему + оптимизацией картинок, так как на слабых компьютерах это может занять прилично + времени. -- GitLab