2024-06-05 08:45:29 +02:00
|
|
|
<div align="center">
|
|
|
|
|
|
|
|
|
|
<img src="https://otmp.4rs.nl/otmp_logo.png" alt="OTMP Logo" width="100" height="100">
|
|
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
# OxideTalis Messaging Protocol (OTMP)
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
A simple site explaining the OxideTalis Messaging Protocol (OTMP).
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-05 08:45:29 +02:00
|
|
|
</div>
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
## How to view the site?
|
|
|
|
|
There are three ways to view the site, you can choose any of them
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
### View the site online (if available)
|
2024-06-05 08:45:29 +02:00
|
|
|
You can view the site online by visiting the following link:
|
|
|
|
|
[https://otmp.4rs.nl](https://otmp.4rs.nl)
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
### Build the site locally
|
|
|
|
|
You can build the site locally by following the steps below:
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-13 14:50:19 +02:00
|
|
|
> [!NOTE]
|
|
|
|
|
> My current zola version is `0.18.0`.
|
2022-12-05 13:48:27 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
```bash
|
|
|
|
|
# Clone the repository
|
|
|
|
|
git clone https://git.4rs.nl/awiteb/otmp_site.git
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
# Change directory to the repository
|
|
|
|
|
cd otmp_site
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
# Build the site
|
|
|
|
|
zola build
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
The site will be built in the `public` directory (you can view it by opening the `index.html` file in your browser)
|
2022-12-03 20:01:01 +01:00
|
|
|
```
|
|
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
### `site` branch
|
2024-06-05 08:45:29 +02:00
|
|
|
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.
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
## How to contribute?
|
2024-06-05 08:45:29 +02:00
|
|
|
Write changes can be made at `templates` directory. You can't change the
|
|
|
|
|
`content` directory as it contains the protocol itself.
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
You can open an issue to write a comments or suggestions about the protocol.
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
## `deploy.sh` script
|
|
|
|
|
Simple script to build the site and push it to GitHub pages.
|
2022-12-03 20:01:01 +01:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
## Credits
|
2023-04-05 21:37:25 +02:00
|
|
|
|
2024-06-05 08:45:29 +02:00
|
|
|
### 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:
|
2023-04-05 21:37:25 +02:00
|
|
|
|
2024-06-01 11:45:20 +02:00
|
|
|
```bash
|
|
|
|
|
git log --author="Awiteb <a@4rs.nl>" -p templates
|
2024-06-05 08:45:29 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 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).
|
