From 3c65fe1699351defe443951f4bb4c5f7a5cf550c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zden=C4=9Bk=20Borovec?=
 <46405012+Zeftax@users.noreply.github.com>
Date: Sat, 27 Apr 2024 20:22:13 +0000
Subject: [PATCH] Create README.md

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b886016
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# My personal home page
+
+The goal of this website is to serve as my personal dumping grounds for some
+small web projects, a blog, maybe a booru gallery. Idk yet.
+
+## Deploy guide
+If you want to use my website as some sort of a template for your own,
+feel free to do so!
+I would appreciate if you give me some form of a credit in the footer of your
+page, especially if you are going to just re-skin my page for
+your own blog site, but I do not require it.
+Anyways, let's get to the *how*.
+ - My page is written in PHP, I run it on an apache server, but it probably
+	should run on nginx as well, I am not sure though, as I have never tested it.
+ - I am not going to walk you through LAMP setup,
+	as that can be found elsewhere.
+ - In the root of the project you will find a database.sql file, you should be
+	able to use it to deploy my database schema. I use mariadb,
+	but if you use mysql it should work as well.
+ - The database is documented through comments viewable in phpmyadmin,
+	if you have trouble displaying them in your database manager, let me know
+	and I might get to writing some basic setup instructions here.
+ - In the file `docs/common/config.php` you can set the connections to your
+	database that will then be used in `docs/common/header.php`
+	to connect to it and set the global variable `$conn` to the PDO
+	connection object, you can use that in your own functions, if you add any.
+ - If you have problems connecting to the database, you can try
+ 	printing the PDO exception being caught there in the function
+	`attempt_sql_connect()`, but be careful not to leave it in production, as
+	it reveals some information you might want to keep from users.
+ - The basic skeleton for any document should be:
+```php
+<?php
+// Title for your page
+$PageTitle="Your title";
+
+// This makes for less typing while including the header and the footer.
+// Absolute path to the commons folder.
+$COMMONS = $_SERVER['DOCUMENT_ROOT'] . "/../common";
+
+// Include the common site-wide header.
+include_once($COMMONS."/header.php");
+?>
+
+<!--
+Your main content here, try to wrap it in <article> tags for nice padding
+-->
+
+<?php
+// Write out the footer and close the website.
+include_once($COMMONS."/footer.php");
+?>
+```
+ - Do check out the already existing css rules before adding your own, the rule
+	for what you are trying to create might already exist. I might add a more
+	comprehensive guide/documentation for the styles once I find myself getting
+	lost in them, but I don't find it necessary yet so I will not bother.
+	If you do, feel free to send me a pull request.
+ - Hmm, what else may I be missing? Not sure now, if you miss something lmk.
+	So I guess have fun!