diff --git a/assets/icons/xlrgb-logo.png b/assets/icons/xlrgb-logo.png new file mode 100644 index 00000000..915503f4 Binary files /dev/null and b/assets/icons/xlrgb-logo.png differ diff --git a/docs/README.md b/docs/README.md index 030b97d4..bec34eb9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 +
+ From Packaged Binary -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) +
-#### Windows: -- [Windows Binary Installation](https://x-r-g-b.github.io/R-Bus/user-guide/installation/packaged-binary/windows.html) +
+ From Source -### 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. +
+ +## :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) diff --git a/docs/user-guide/installation/packaged-binary/gnu-linux.md b/docs/user-guide/installation/packaged-binary/gnu-linux.md index 81da2573..12446b38 100644 --- a/docs/user-guide/installation/packaged-binary/gnu-linux.md +++ b/docs/user-guide/installation/packaged-binary/gnu-linux.md @@ -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/ ``` diff --git a/docs/user-guide/installation/packaged-binary/macos.md b/docs/user-guide/installation/packaged-binary/macos.md index e4284b1f..d4991bde 100644 --- a/docs/user-guide/installation/packaged-binary/macos.md +++ b/docs/user-guide/installation/packaged-binary/macos.md @@ -1,3 +1,5 @@ # MacOs -Not available now +Download + +And launch the file downloaded. diff --git a/docs/user-guide/installation/packaged-binary/windows.md b/docs/user-guide/installation/packaged-binary/windows.md index 15ffe309..55abbaf4 100644 --- a/docs/user-guide/installation/packaged-binary/windows.md +++ b/docs/user-guide/installation/packaged-binary/windows.md @@ -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 + +And execute the file downloaded.