diff options
author | Egor Tensin <egor@tensin.name> | 2023-12-14 01:55:36 +0100 |
---|---|---|
committer | Egor Tensin <egor@tensin.name> | 2023-12-14 01:56:37 +0100 |
commit | 2cffd57767bede276cd2087f5ba9b60107e6e341 (patch) | |
tree | 6968e76a04f52853cee948595db4fce969b6762f | |
parent | reword things a bit again (diff) | |
download | fucktipp.ing-2cffd57767bede276cd2087f5ba9b60107e6e341.tar.gz fucktipp.ing-2cffd57767bede276cd2087f5ba9b60107e6e341.zip |
copy README.md & DEVELOPMENT.md from my other Jekyll projects
-rw-r--r-- | DEVELOPMENT.md | 34 | ||||
-rw-r--r-- | README.md | 25 |
2 files changed, 59 insertions, 0 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..18dfbb0 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,34 @@ +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 website and serve it at http://localhost:4000/: + + make serve + + * It will pick up changes and reload pages automatically. + +Upgrading dependencies +---------------------- + + bundle update diff --git a/README.md b/README.md new file mode 100644 index 0000000..a1a451f --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +fucktipp.ing +============ + +[![CI](https://github.com/egor-tensin/fucktipp.ing/actions/workflows/jekyll.yml/badge.svg)](https://github.com/egor-tensin/fucktipp.ing/actions/workflows/jekyll.yml) + +Fuck tipping: https://fucktipp.ing/. + +Development +----------- + +This is a static website, built using [Jekyll]. + +[Jekyll]: https://jekyllrb.com/ + +See [DEVELOPMENT.md] for details. + +[DEVELOPMENT.md]: DEVELOPMENT.md + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt |