diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2023-07-13 23:35:11 +0200 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2023-07-13 23:35:11 +0200 |
| commit | 08dbfb6246994c44a5b471e816d4e9ef93ea9fc8 (patch) | |
| tree | 9dc564a45b501ac299aee9331b73d1cb2e003d37 | |
| parent | Makefile: move the prelude to prelude.mk (diff) | |
| download | sorting-algorithms-08dbfb6246994c44a5b471e816d4e9ef93ea9fc8.tar.gz sorting-algorithms-08dbfb6246994c44a5b471e816d4e9ef93ea9fc8.zip | |
add DEVELOPMENT.md
| -rw-r--r-- | DEVELOPMENT.md | 38 | ||||
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | _config.yml | 1 |
3 files changed, 43 insertions, 18 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..302df59 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,38 @@ +Workspace setup +--------------- + +* To reduce pain, set up [rbenv] to manage your Ruby versions. +Install one that's known to work: `make ruby` + * Otherwise, make sure you have Ruby and [Bundler] set up. +* Install dependencies: `make deps` +* Make sure builds are working: `make build` + +[rbenv]: https://github.com/rbenv/rbenv +[Bundler]: https://bundler.io/ + +Development +----------- + +* Build the example website and serve it at http://localhost:4000/sorting-algorithms/: +`make serve` + * It will pick up changes and reload pages automatically. + +Upgrading dependencies +---------------------- + + bundle update + +Building static pages +--------------------- + +If you try to copy the _site directory and open index.html without running the +web server, it won't work: all links will be messed up. +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: + + make serve LIVE_RELOAD=0 # Live reloading breaks wget + make wget + +The truly static version will be downloaded to the .wget/ directory. @@ -9,29 +9,15 @@ 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. +This is a static website, built using [Jekyll]. +[jekyll-theme] is used as the 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:// +See [DEVELOPMENT.md] for details. -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. +[DEVELOPMENT.md]: DEVELOPMENT.md License ------- diff --git a/_config.yml b/_config.yml index 59abb0d..c0b73be 100644 --- a/_config.yml +++ b/_config.yml @@ -6,6 +6,7 @@ show_drafts: true strict_front_matter: true exclude: + - DEVELOPMENT.md - Makefile - prelude.mk - README.md |