Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/rb 156 better readme #133

Merged
merged 3 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/icons/xlrgb-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 47 additions & 36 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,71 @@
# R-Bus

A horizontally scrolling shooter multiplayer arcade video game.

## :airplane: Cross-Platform

[![Release](https://github.com/X-R-G-B/R-Bus/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/X-R-G-B/R-Bus/actions/workflows/release.yml)

[![Compil](https://github.com/X-R-G-B/R-Bus/actions/workflows/compil.yml/badge.svg?branch=main)](https://github.com/X-R-G-B/R-Bus/actions/workflows/compil.yml)

```
R-Type[a] is a horizontally scrolling shooter arcade video game developed
and released by Irem in 1987 and the first game in the R-Type series.
The player controls a star ship, the R-9 "Arrowhead", in its efforts to
destroy the Bydo, a powerful alien race bent on wiping out all of mankind.
The R-9 can acquire a glowing orbicular device called a "Force",
protecting it from enemy fire and providing additional firepower.
The arcade version was distributed by Nintendo in North America;
it is the last arcade title Nintendo distributed.
```
[wikipedia](https://en.wikipedia.org/wiki/R-Type)
R-Bus is designed to be cross-platform, available on **Windows**, **Linux**, and **MacOS**.

## Gameplay
## :arrow_double_down: Installation

- Horizontally scrolling shooter
Installing R-Bus is easy.

- Single player / Multi player
Follow the instructions below based on your preferred method and operating system.

- 2D
There are two ways to install R-Bus:
- :package: From packaged binary: Prefer this method if you want to avoid downloading dependencies and compiling R-Bus.
- :hammer: From source: Choose this method if you're comfortable with handling dependencies and compilation.

## Installation
<details>
<summary>From Packaged Binary</summary>

Installing R-Bus is easy. Follow the instructions below based on your preferred method and operating system.
### :package: From Packaged Binary

There are two ways to install R-Bus:
- From packaged binary: Prefer this method if you want to avoid downloading dependencies and compiling R-Bus.
- From source: Choose this method if you're comfortable with handling dependencies and compilation.
#### :penguin: GNU/Linux
- [GNU/Linux Binary Installation Instruction](https://x-r-g-b.github.io/R-Bus/user-guide/installation/packaged-binary/gnu-linux.html)

#### :window: Windows
- [Windows Binary Installation Instruction](https://x-r-g-b.github.io/R-Bus/user-guide/installation/packaged-binary/windows.html)

### From Packaged Binary:
#### :apple: MacOS
- [MacOS Binary Installation Instruction](https://x-r-g-b.github.io/R-Bus/user-guide/installation/packaged-binary/macos.html)

#### GNU/Linux:
- [GNU/Linux Binary Installation](https://x-r-g-b.github.io/R-Bus/user-guide/installation/packaged-binary/gnu-linux.html)
</details>

#### Windows:
- [Windows Binary Installation](https://x-r-g-b.github.io/R-Bus/user-guide/installation/packaged-binary/windows.html)
<details>
<summary>From Source</summary>

### From Source:
### :hammer: From Source

#### GNU/Linux:
- [GNU/Linux Source Installation](https://x-r-g-b.github.io/R-Bus/user-guide/installation/source/gnu-linux.html)
#### :penguin: GNU/Linux
- [GNU/Linux Source Installation Instruction](https://x-r-g-b.github.io/R-Bus/user-guide/installation/source/gnu-linux.html)

#### Windows:
- [Windows Source Installation](https://x-r-g-b.github.io/R-Bus/user-guide/installation/source/windows.html)
#### :window: Windows
- [Windows Source Installation Instruction](https://x-r-g-b.github.io/R-Bus/user-guide/installation/source/windows.html)

#### MacOS:
- [MacOS Source Installation](https://x-r-g-b.github.io/R-Bus/user-guide/installation/source/macos.html)
#### :apple: MacOS
- [MacOS Source Installation Instruction](https://x-r-g-b.github.io/R-Bus/user-guide/installation/source/macos.html)

## Cross-Platform
R-Bus is designed to be cross-platform, available on Windows, Linux, and MacOS.
</details>

## :book: Documentation
- [R-Bus Documentation](https://x-r-g-b.github.io/R-Bus/)

## :bookmark_tabs: License
R-Bus is licensed under the [MIT License](https://github.com/X-R-G-B/R-Bus/blob/dev/LICENSE).

## Created By X-L-R-G-B
This project is a collaborative effort by Xavier, Leonore, Romain, Guillaume, and Brice.

*if you are on github repo, you can see the mdbook here: [https://x-r-g-b.github.io/R-Bus/](https://x-r-g-b.github.io/R-Bus/)*
![logo](https://raw.githubusercontent.com/X-R-G-B/R-Bus/dev/assets/icons/xlrgb-logo.png)

This project is a collaborative effort by:

- [Xavier](https://github.com/Saverio976)
- [Leonore](https://github.com/TTENSHII)
- [Romain](https://github.com/romainpanno)
- [Guillaume](https://github.com/guillaumeAbel)
- [Brice](https://github.com/KitetsuK)
8 changes: 5 additions & 3 deletions docs/user-guide/installation/packaged-binary/gnu-linux.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# GNU/Linux

```bash
curl -Lo 'r-type-linux.sh' 'https://github.com/X-R-G-B/R-Bus/releases/latest/download/r-type-linux.sh'
# The following line will Accepts the license, extract the packaged binary + its dependencies
curl -Lo 'r-type-linux.sh' \
'https://github.com/X-R-G-B/R-Bus/releases/latest/download/r-type-linux.sh'
# The following line will Accepts the license
# extract the packaged binary and its dependencies
yes y | bash 'r-type-linux.sh'
cd R-Type-Linux || echo "Failed to cd to R-Type-Linux, please open an issue: 'https://github.com/X-R-G-B/R-Bus/issues/new?assignees=&labels=bug&projects=&template=install-failed.yml&title=%5BFAIL+INSTALL%5D+-+Title'"
cd R-Type-Linux
# your binaries are in ./bin/
ls ./bin/
```
Expand Down
4 changes: 3 additions & 1 deletion docs/user-guide/installation/packaged-binary/macos.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# MacOs

Not available now
Download <https://github.com/X-R-G-B/R-Bus/releases/latest/download/r-type-macos.dmg>

And launch the file downloaded.
4 changes: 3 additions & 1 deletion docs/user-guide/installation/packaged-binary/windows.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Windows

Download https://github.com/X-R-G-B/R-Bus/releases/latest/download/r-type-windows.exe and run it
Download <https://github.com/X-R-G-B/R-Bus/releases/latest/download/r-type-windows.exe>

And execute the file downloaded.
Loading