Skip to content

Commit 16a1943

Browse files
authored
Update README to make Docker Recommended way (alshedivat#1523)
Docker is well-tested for a long time. I think it is better to make it the recommended method for all OS types. This way, it is a lot easier to install docker (than to install jekyll and ruby and what not) and also we wouldn't have to deal with issues like these: - alshedivat#1520 - alshedivat#1491
1 parent 920cb69 commit 16a1943

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -155,14 +155,13 @@ Medical Robotics Junior Faculty Forum (ISMR: <a href="https://junior-forum-ismr.
155155

156156
## Table Of Contents
157157

158-
- [al-folio](#al-folio)
159-
- [User community](#user-community)
160-
- [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
161-
- [Table Of Contents](#table-of-contents)
162-
- [Getting started](#getting-started)
158+
* [User community](#user-community)
159+
* [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
160+
* [Table Of Contents](#table-of-contents)
161+
* [Getting started](#getting-started)
163162
- [Installation](#installation)
164-
- [Local setup using Docker (Recommended on Windows)](#local-setup-using-docker-recommended-on-windows)
165-
- [Local Setup (Standard)](#local-setup-standard)
163+
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
164+
- [Local Setup (Legacy)](#local-setup-legacy)
166165
- [Deployment](#deployment)
167166
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
168167
- [FAQ](#faq)
@@ -204,18 +203,19 @@ $ cd <your-repo-name>
204203

205204
---
206205

207-
#### Local setup using Docker (Recommended on Windows)
206+
#### Local setup using Docker (Recommended)
207+
Using Docker to install Jekyll and Ruby dependencies is the easiest way.
208208

209-
You need to take the following steps to get `al-folio` up and running in your local machine:
209+
You need to take the following steps to get `al-folio` up and running on your local machine:
210210

211211
- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
212-
- Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
212+
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.
213213

214214
```bash
215215
$ docker-compose up
216216
```
217217

218-
Note that when you run it for the first time, it will download a docker image of size 300MB or so.
218+
Note that when you run it for the first time, it will download a docker image of size 400MB or so.
219219

220220
Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (`docker-compose up`) to render the webpage with all you changes. Also, make sure to commit your final changes.
221221

@@ -237,7 +237,7 @@ $ docker-compose -f docker-local.yml up
237237

238238
---
239239

240-
#### Local Setup (Standard)
240+
#### Local Setup (Legacy)
241241

242242
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), and also [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (*hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/). If you will use only `jupyter`, you can use [pipx](https://pypa.github.io/pipx/)*).
243243

0 commit comments

Comments
 (0)