OxideTalis/otmp_site
1
Fork 0
Code Issues Pull requests Releases Activity Actions

chore: Update README.md
All checks were successful
Build site / Rust CI (push) Successful in 24s
Details

Browse source 
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb 2024-06-05 09:45:29 +03:00
parent 6f410a82f1
commit e4b310fc1c
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,19 +1,24 @@
<div align="center">
<img src="https://otmp.4rs.nl/otmp_logo.png" alt="OTMP Logo" width="100" height="100">
# OxideTalis Messaging Protocol (OTMP)
A simple site explaining the OxideTalis Messaging Protocol (OTMP).
</div>
## 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 <a@4rs.nl>" -p templates
```
```
### 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).