From e44e2fe070484e06d384a31ef2699c3a2d5d474e Mon Sep 17 00:00:00 2001
From: RaindropsSys <raindrops@equestria.dev>
Date: Thu, 13 Jun 2024 15:46:03 +0200
Subject: GitHub migration

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100755 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..d3dba1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Prisbeam
+A browser and search engine for local copies of various image boards (Derpibooru, Furbooru, e621, ...)
+
+## Development
+Assuming you are using macOS or Linux. Other POSIX systems won't work as Electron does not have binaries for these.
+
+### Cloning
+```
+git clone https://source.equestria.dev/equestria.dev/prisbeam
+```
+
+### Setup
+```
+# Note: this will install TypeScript globally
+npm install
+```
+
+### Running
+```
+# For the app itself:
+npm run debug
+
+# For the updater:
+npm run debug-updater
+```
+
+### Building
+```
+# This will run 'npm audit fix' and 'npm install' to update dependencies if needed
+npm run release
+```
-- 
cgit