From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <zxce3@gnuweeb.org>
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on gnuweeb.org
X-Spam-Level: 
X-Spam-Status: No, score=-1.2 required=5.0 tests=ALL_TRUSTED,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NUMERIC_HTTP_ADDR,URIBL_BLOCKED,
	WEIRD_PORT autolearn=ham autolearn_force=no version=3.4.6
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gnuweeb.org;
	s=default; t=1681545563;
	bh=Fqta4N5yeHVMkHvaK//yyFBWPrFvyPxk/MvNZMhIxaE=;
	h=From:To:Cc:Subject:Date:In-Reply-To:References;
	b=RQ2Wkk5647YMNJ1TFZBvSl+J40i5V30Y9WxWRB39EP5gY4HmAEl68FWQAz1Iqlb6Q
	 pOKV4ZSKJWr9FjHYb/uPMFf+qJJsB/GvbgquGqk6yBNHzeWtWRs3pAwTJHm5l9+nbR
	 ov8pvY7yxHz6TO97fRuqLa2pm1gWTg7ibW8ZtzpndE8Qpj401SjdUHFmhzXk9eLmLr
	 5bZvcPmadvDvakt3bNFP0G/fAtZFVwW7SjLDkFMDtYJhnPYwMRiVi41LJSmaAI6xaL
	 z9PZHtTcihaLpPIKBepm996VEeYALVoZJRl2KjIusKcxktkaaMMFQX4yN6qQ2s9FeP
	 sjnLYR1WL9kdg==
Received: from localhost.localdomain (unknown [182.1.21.53])
	by gnuweeb.org (Postfix) with ESMTPSA id ACD582454E6;
	Sat, 15 Apr 2023 14:59:22 +0700 (WIB)
From: Memet Zx <zxce3@gnuweeb.org>
To: GNU/Weeb Mailing List <gwml@vger.gnuweeb.org>
Cc: Ammar Faizi <ammarfaizi2@gnuweeb.org>,
	Memet Zx <zxce3@gnuweeb.org>
Subject: [PATCH: Website v1 2/2] README.md: Initialize the information
Date: Sat, 15 Apr 2023 14:59:04 +0700
Message-Id: <20230415075904.237392-3-zxce3@gnuweeb.org>
X-Mailer: git-send-email 2.34.1
In-Reply-To: <20230415075904.237392-1-zxce3@gnuweeb.org>
References: <20230415075904.237392-1-zxce3@gnuweeb.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
List-Id: <gwml.vger.gnuweeb.org>

The README.md file provides important information about the project,
including its purpose, how to install and run it, and any dependencies or requirements.
This file will help other developers understand the project and contribute to it more easily.
Additionally, it will serve as a reference for future development and maintenance tasks.

Signed-off-by: Memet Zx <zxce3@gnuweeb.org>
---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..87929b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# GNU/Weeb Website
+
+Build comunity through Open Source technology.
+
+Welcome to new website repo for GNU/Weeb. This is a new website for GNU/Weeb. This website is built with pure PHP native and HTML5.
+
+## How to contribute
+
+You can contribute to this website by forking this repo and make a pull request. You can also contribute by opening an issue.
+
+## Installation
+
+- Clone this repo.
+- `cd` into the root directory.
+- copy `config.example.php` to `config.php` and edit it.
+- and run this command:
+
+    ```bash
+    php -S localhost:8000 -t public public/index.php
+    ```
+
+- Open your browser and go to `localhost:8000`
+
+## Configuration
+
+default configuration is:
+
+```php
+<?php
+
+define("BASEURL", "http://127.0.0.1:8000");
+define("LOGS_DIR", __DIR__."/logs");
+define("PUBLIC_DIR", __DIR__."/public");
+define("APP_TITLE", "The GNU/Weeb Website");
+```
+
+you can call the `config` like this:
+
+```php
+<title><?= e(APP_TITLE); ?></title>
+```
+
+### Custom config
+
+you can made a custom config for each page for example:
+
+```php
+<?php
+
+$opt["type"] = "Something";
+
+?>
+```
+
+and call it with `<?= e($opt["type"] ?? "") ?>`
-- 
Memet Zx