aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
blob: 83ade20a0a41d9dc519bf69f509b03f769282f4c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Sorting algorithms
==================

[![Jekyll](https://github.com/egor-tensin/sorting-algorithms/actions/workflows/jekyll.yml/badge.svg)](https://github.com/egor-tensin/sorting-algorithms/actions/workflows/jekyll.yml)

Getting the hang out of (sorting) algorithms.
Hosted at https://egort.name/sorting-algorithms/.

Development
-----------

This is a static website, generated using [Jekyll].

Make sure you have Ruby and [Bundler] set up.
[GNU Make] is used for shortcuts.

* Install dependencies by running `make deps`.
* Build the website by running `make build`.
* Launch a local web server by running `make serve`.
Access the website at http://localhost:4000/sorting-algorithms/.

[jekyll-theme] is used as a remote Jekyll theme.

[Jekyll]: https://jekyllrb.com/
[Bundler]: https://bundler.io/
[GNU Make]: https://www.gnu.org/software/make/
[jekyll-theme]: https://github.com/egor-tensin/jekyll-theme

### Access via file://

Jekyll doesn't provide native support for generating a static website which can
be browsed without running a web server.
One workaround is to `wget` the website (use `make wget`).
The truly static version will be downloaded to the .wget/ directory.

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt