From 9b42d05174b0ccc480e0ccefb54edf85dcbe4dc0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lera=20Elvo=C3=A9?= <yagich@poto.cafe>
Date: Thu, 22 May 2025 00:31:54 +0300
Subject: [PATCH] start writing instructions (not complete yet)

---
 README.md            | 23 +++++++++++++++--------
 porom-dev-1.rockspec | 25 +++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 8 deletions(-)
 create mode 100644 porom-dev-1.rockspec

diff --git a/README.md b/README.md
index 5edea66..dc18aa9 100644
--- a/README.md
+++ b/README.md
@@ -5,16 +5,23 @@ porous forum
 Released under [CNPLv7+](https://thufie.lain.haus/NPL.html).
 Please read the [full terms](./LICENSE.md) for proper wording.
 
-# deps
-this is all off the top of my head so if you try to run it got help you
+# installing
+1. first, install OpenResty. instructions for linux can be found [here](https://openresty.org/en/linux-packages.html).
+2. then, install LuaJIT
+3. then, install [LuaRocks](https://luarocks.org) (prefer your package manager instead of a local install recommended by the guide)
+4. add luarocks search dirs to path:
 
-- lapis
-- lsqlite3
-- [magick](https://github.com/leafo/magick)
-- bcrypt
-- luaossl
+```bash
+  # in .bashrc (or other shell equivalent)
+  eval "$(luarocks --lua-version 5.1 path)"
+```
+5. clone repo
+6. install the dependencies:
 
-i think thats it
+```bash
+luarocks --local --lua-version 5.1 build --only-deps
+```
+7. rest is TBD until a start script is provided
 
 # icons
 the icons in the `icons/` folder are by [Gabriele Malaspina](https://www.figma.com/community/file/1136337054881623512/iconcino-v2-0-0-free-icons-cc0-1-0-license)
diff --git a/porom-dev-1.rockspec b/porom-dev-1.rockspec
new file mode 100644
index 0000000..e82d4e1
--- /dev/null
+++ b/porom-dev-1.rockspec
@@ -0,0 +1,25 @@
+package = "porom"
+version = "dev-1"
+
+source = {
+  url = "ssh://gitea@git.poto.cafe:222/yagich/porom.git"
+}
+
+description = {
+  summary = "Homegrown forum software",
+  homepage = "",
+  license = "CNPLv7+"
+}
+
+dependencies = {
+  "lua ~> 5.1",
+  "lapis == 1.16.0",
+  "lsqlite3",
+  "magick",
+  "bcrypt",
+  "luaossl",
+}
+
+build = {
+  type = "none"
+}