From e4b310fc1c73edaf69a7f9209ca6369a3cdf358a Mon Sep 17 00:00:00 2001 From: Awiteb Date: Wed, 5 Jun 2024 09:45:29 +0300 Subject: [PATCH] chore: Update README.md Signed-off-by: Awiteb --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f0cd3d2..5462297 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,24 @@ +
+ +OTMP Logo + # OxideTalis Messaging Protocol (OTMP) A simple site explaining the OxideTalis Messaging Protocol (OTMP). +
## How to view the site? There are three ways to view the site, you can choose any of them ### View the site online (if available) -You can view the site online by visiting the following link: [https://otmp.4rs.nl](https://otmp.4rs.nl) +You can view the site online by visiting the following link: +[https://otmp.4rs.nl](https://otmp.4rs.nl) ### Build the site locally You can build the site locally by following the steps below: -> [!NOTE] -> My current zola version is `0.18.0`. +> [!NOTE] My current zola version is `0.18.0`. ```bash # Clone the repository @@ -29,10 +34,12 @@ The site will be built in the `public` directory (you can view it by opening the ``` ### `site` branch -You can view the site by visiting the `site` branch of the repository. The site is built and pushed to the `site` branch automatically by the CI pipeline. +You can view the site by visiting the `site` branch of the repository. The site +is built and pushed to the `site` branch automatically by the CI pipeline. ## How to contribute? -Write changes can be made at `templates` directory. You can't change the `content` directory as it contains the protocol itself. +Write changes can be made at `templates` directory. You can't change the +`content` directory as it contains the protocol itself. You can open an issue to write a comments or suggestions about the protocol. @@ -41,8 +48,19 @@ Simple script to build the site and push it to GitHub pages. ## Credits -This **site** is built on top of Ahmed Alaa [no-style-please](https://gitlab.com/atgumx/no-style-please) theme, with some modifications, you can view the changes at the `templates` directory by running the following command: +### Theme +This **site** is built on top of Ahmed Alaa +[no-style-please](https://gitlab.com/atgumx/no-style-please) theme, with some +modifications, you can view the changes at the `templates` directory by running +the following command: ```bash git log --author="Awiteb " -p templates -``` \ No newline at end of file +``` + +### Logo +The orignal logo is designed by [Lorc](https://lorcblog.blogspot.com/) under [CC +BY 3.0](http://creativecommons.org/licenses/by/3.0/) license. The logo is +modified by [Awiteb](https://4rs.nl), you can view the changes at the +`static/otmp_logo.png` file. The original logo can be found at +[game-icons.net](https://game-icons.net/1x1/lorc/atomic-slashes.html). \ No newline at end of file