From 259e8ab7a3a7e607263ca07e53787d85881bab8a Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Tue, 25 Sep 2018 19:13:16 +0200 Subject: Re-bumped much of the application MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d4c6fd --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# jo + +Files for my personal website. In order to get started, you need to install +[yarn](https://yarnpkg.com/) and you need a proper ruby development environment +(with bundler already installed). Then, you can simply fetch dependencies like +so: + +``` +$ yarn +$ bundle +``` + +After that, build Javascript files with: + +``` +$ yarn run webpack +``` + +And in another session start Jekyll with: + +``` +$ bundle exec jekyll serve +``` + +If you just want to **deploy**, simply run: + +``` +$ ./script/build.sh +``` + +This will write everything into a `_site` directory. Use this directory to serve +all files. + +## License + +This project is licensed under the AGPLv3. See [LICENSE](./LICENSE) for the full +license text. -- cgit v1.2.3