From 2ac4a878656920a38b5c48548f511bf3710c8967 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sat, 27 Apr 2024 19:09:13 -0400 Subject: [PATCH] Rename user config (#18) - Update installation instructions --- .gitignore | 1 + INSTALLING.md | 2 +- src/{user-config.php => user-config.dist.php} | 5 ++--- 3 files changed, 4 insertions(+), 4 deletions(-) rename src/{user-config.php => user-config.dist.php} (89%) diff --git a/.gitignore b/.gitignore index 73afc4d..f9b4ff3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .idea src/data/*.db +src/user-config.php diff --git a/INSTALLING.md b/INSTALLING.md index 70854f8..bcfcb3a 100644 --- a/INSTALLING.md +++ b/INSTALLING.md @@ -27,7 +27,7 @@ The default `Caddyfile` will run the site at `http://localhost:8205`. To have th ## Feed Reader Central Behavior -Within the `/src` directory, there is a file named `user-config.php`. This file is the place for customizations and configuration of the instance's behavior. +Within the `/src` directory, there is a file named `user-config.dist.php`. Rename this file to `user-config.php`; this is where customizations and configuration of the instance's behavior are placed. ### Security Model diff --git a/src/user-config.php b/src/user-config.dist.php similarity index 89% rename from src/user-config.php rename to src/user-config.dist.php index e0ca5f8..7b3f824 100644 --- a/src/user-config.php +++ b/src/user-config.dist.php @@ -3,6 +3,8 @@ * USER CONFIGURATION ITEMS * * Editing the values here customizes the behavior of Feed Reader Central + * + * On initial installation, rename this file to user-config.php and configure it as desired */ @@ -23,6 +25,3 @@ const DATABASE_NAME = 'frc.db'; * The default, 'F j, Y \a\t g:ia', equates to "August 17, 2023 at 4:45pm" */ const DATE_TIME_FORMAT = 'F j, Y \a\t g:ia'; - -// END USER CONFIGURATION ITEMS -// (editing below this line is not advised)