diff --git a/README.md b/README.md index f673903a7cd706ea256ae31025b90aae74f22351..f631975f4b9b39e9219576d84665278804ea75a7 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`, заранее оптимизировав их. Сборщик - проÑто копирует иÑпользуемые Ð¸Ð·Ð¾Ð±Ñ€Ð°Ð¶ÐµÐ½Ð¸Ñ Ñ‡Ñ‚Ð¾Ð±Ñ‹ не нагружать вашу ÑиÑтему - оптимизацией деÑÑтков картинок, так как на Ñлабых компьютерах Ñто повеÑит - ÑиÑтему. + проÑто копирует иÑпользуемые Ð¸Ð·Ð¾Ð±Ñ€Ð°Ð¶ÐµÐ½Ð¸Ñ Ñ‡Ñ‚Ð¾Ð±Ñ‹ не нагружать ÑиÑтему + оптимизацией картинок, так как на Ñлабых компьютерах Ñто может занÑть прилично + времени.