diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2022-03-02 15:06:30 +0500 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2022-03-02 15:06:30 +0500 |
| commit | 0e5197231e1c1692e38ab197141f947664ea2616 (patch) | |
| tree | d158411fd6e5aca523d852cc4341a9288f5552dd /README.md | |
| parent | add Makefile for shortcuts (diff) | |
| download | sorting-algorithms-0e5197231e1c1692e38ab197141f947664ea2616.tar.gz sorting-algorithms-0e5197231e1c1692e38ab197141f947664ea2616.zip | |
README: update
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 12 insertions, 22 deletions
@@ -11,39 +11,29 @@ Hosted on [GitHub Pages] at https://egor-tensin.github.io/sorting-algorithms/. Development ----------- -[Jekyll] is used to build a set of static HTML pages from a collection of -templates and resources. -[Bundler] is used to manage project's dependencies. -Make sure you have the `bundler` gem installed; project dependencies can then -be installed by executing +This is a "static" website, generated using [Jekyll]. - bundle install +Make sure you have Ruby and [Bundler] set up. +[GNU Make] is used for shortcuts. -in the project's root directory. - -To run a local web server, run - - bundle exec jekyll serve --drafts - -You can then review your changes at http://localhost:4000/sorting-algorithms/. - -Or you can use [jekyll-docker] to set up a development environment in Docker -and not bother with installing everything locally. +* 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]: http://bundler.io/ -[jekyll-docker]: https://github.com/egor-tensin/jekyll-docker +[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 an instance of Jekyll's web server. -One easy workaround is to `wget` the website and convert the links: - - wget --no-verbose --recursive --convert-links --adjust-extension -- http://localhost:4000/sorting-algorithms/ +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 ------- |