public inbox for [email protected]
 help / color / mirror / Atom feed
From: Memet Zx <[email protected]>
To: GNU/Weeb Mailing List <[email protected]>
Cc: Ammar Faizi <[email protected]>, Memet Zx <[email protected]>
Subject: [PATCH: Website v1 2/2] README.md: Initialize the information
Date: Sat, 15 Apr 2023 14:59:04 +0700	[thread overview]
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>

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 <[email protected]>
---
 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


  parent reply	other threads:[~2023-04-15  7:59 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-15  7:59 [PATCH: Website v1 0/2] Changes to head.php and addition of README.md Memet Zx
2023-04-15  7:59 ` [PATCH: Website v1 1/2] head.php: Fix issue with css/js head section Memet Zx
2023-04-15 13:40   ` Ammar Faizi
2023-04-15  7:59 ` Memet Zx [this message]
2023-04-15 13:43   ` [PATCH: Website v1 2/2] README.md: Initialize the information Ammar Faizi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox