aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--DEVELOPMENT.md34
-rw-r--r--README.md25
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