docmachine-containers/README.md

55 lines
783 B
Markdown
Raw Normal View History

2020-04-19 10:07:35 +00:00
# Teaching-Boilerplate
2018-04-20 15:27:59 +00:00
2020-04-19 10:07:35 +00:00
## Prerequisites
2018-04-20 15:27:59 +00:00
2020-04-19 10:07:35 +00:00
Make sure you have python and node installed
2018-04-20 15:27:59 +00:00
2021-07-21 11:58:16 +00:00
git remote rename origin boilerplate
git remote add origin git@...
2021-07-21 11:59:28 +00:00
git checkout -b upstream/boilerplate/master --track
2021-07-21 11:58:16 +00:00
2020-04-19 10:07:35 +00:00
Install python packages
2018-04-20 15:27:59 +00:00
2020-04-19 10:07:35 +00:00
pip install -U pipenv
pipenv install
2018-04-20 15:27:59 +00:00
2020-04-19 10:07:35 +00:00
Install node packages
2018-04-20 15:27:59 +00:00
2020-04-19 10:07:35 +00:00
npm install
2018-04-20 15:27:59 +00:00
2020-04-19 10:07:35 +00:00
## Usage
2021-07-21 11:58:16 +00:00
### First steps
Clean this repository
Change the remote
2020-04-19 10:07:35 +00:00
### Watch mode
2022-01-25 16:00:01 +00:00
This mode allows you the result on-the-fly as you make changes in the content.
2020-04-19 10:07:35 +00:00
To use watch mode, type:
make watch
To use watch mode for slides only type:
make watch-slides
To use watch mode for docs only type:
make watch-docs
### Build mode
This mode builds final content for delivery (website, PDF files)
To use build mode:
make build