Readme update

This commit is contained in:
2019-02-13 20:30:43 +01:00
parent e95b0cb407
commit 9a95367760

View File

@@ -1,5 +1,27 @@
To keep the same formatting please consider using Window Maker webpage source
===========================
tidy -i -m 130 -m *.php This is a web page source files. All of the files should be proper markdown
files accepted by [Jekyll](https://jekyllrb.com) static site generator.
after modifying the sources. Build/serve
-----------
In order to build the site, you'll need Jekyll framework installed. Easiest way
to achieve it, is to install it from system repositories.
If your distribution doesn't contain it (even in external ones, like PPA for
Ubuntu, AUR for Arch or some portage overlay from Gentoo), that it might be
installed locally using [Bundler](https://github.com/bundler/bundler), which
typical usage would be as follows:
```
$ cd window-maker.github.io && bundler init
$ bundler add jekyll
$ bundler exec jekyll serve
```
which will initialize gemfile, add jekyll to it, and then perform `jekyll serve`
which underneath will build the site and than run simple http server on
`http://localhost:4000` in development mode. More about jekyll you can find [on
it's page](https://jekyllrb.com/docs)