diff --git a/CMakeLists.txt b/CMakeLists.txt index 51522aaa..09be439c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -181,6 +181,7 @@ set(CPACK_PACKAGE_VENDOR "X-L-R-G-B") include(InstallRequiredSystemLibraries) set(CPACK_PACKAGE_NAME "R-Type") +set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${${CPACK_SYSTEM_NAME}") set(CPACK_PACKAGE_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}") set(CPACK_PACKAGE_VERSION_MINOR "${PROJECT_VERSION_MINOR}") set(CPACK_PACKAGE_VERSION_PATCH "${PROJECT_VERSION_PATCH}") diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e0303f7a..d4e2739a 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -6,7 +6,15 @@ # User Guide -- [Installation](user-guide/installation.md) +- [Installation](user-guide/installation/README.md) + - [From packaged binary](user-guide/installation/packaged-binary/README.md) + - [GNU/Linux](user-guide/installation/packaged-binary/gnu-linux.md) + - [MacOs](user-guide/installation/packaged-binary/macos.md) + - [Windows](user-guide/installation/packaged-binary/windows.md) + - [From source](user-guide/installation/source/README.md) + - [GNU/Linux](user-guide/installation/source/gnu-linux/README.md) + - [MacOs](user-guide/installation/source/macos/README.md) + - [Windows](user-guide/installation/source/windows/README.md) - [Usage](user-guide/usage.md) diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/user-guide/installation/README.md b/docs/user-guide/installation/README.md new file mode 100644 index 00000000..b8099966 --- /dev/null +++ b/docs/user-guide/installation/README.md @@ -0,0 +1,10 @@ +# Installation + +There are two ways to install R-Bus: +- From packaged binary +- From source + +*Prefer the packaged binary if you want to find yoursel downloading some dependencies and compiling R-Bus.* +*Prefer the packaged binary if you are not a nerd* + +Else, go ahead and install R-Bus from source. diff --git a/docs/user-guide/installation/packaged-binary/README.md b/docs/user-guide/installation/packaged-binary/README.md new file mode 100644 index 00000000..edc15d84 --- /dev/null +++ b/docs/user-guide/installation/packaged-binary/README.md @@ -0,0 +1,5 @@ +# Packaged binary + +Now, let's install R-Bus from packaged binary. + +Please select the right page for your operating system diff --git a/docs/user-guide/installation/packaged-binary/gnu-linux.md b/docs/user-guide/installation/packaged-binary/gnu-linux.md new file mode 100644 index 00000000..81da2573 --- /dev/null +++ b/docs/user-guide/installation/packaged-binary/gnu-linux.md @@ -0,0 +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 +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'" +# your binaries are in ./bin/ +ls ./bin/ +``` + +:warnings: When you want to move this binaries, please move all the folder R-Type-Linux diff --git a/docs/user-guide/installation/packaged-binary/macos.md b/docs/user-guide/installation/packaged-binary/macos.md new file mode 100644 index 00000000..e4284b1f --- /dev/null +++ b/docs/user-guide/installation/packaged-binary/macos.md @@ -0,0 +1,3 @@ +# MacOs + +Not available now diff --git a/docs/user-guide/installation/packaged-binary/windows.md b/docs/user-guide/installation/packaged-binary/windows.md new file mode 100644 index 00000000..15ffe309 --- /dev/null +++ b/docs/user-guide/installation/packaged-binary/windows.md @@ -0,0 +1,3 @@ +# Windows + +Download https://github.com/X-R-G-B/R-Bus/releases/latest/download/r-type-windows.exe and run it diff --git a/docs/user-guide/installation/source/README.md b/docs/user-guide/installation/source/README.md new file mode 100644 index 00000000..11b9f337 --- /dev/null +++ b/docs/user-guide/installation/source/README.md @@ -0,0 +1,5 @@ +# Source + +Now, let's install R-Bus from source. + +Please select the right page for your operating system diff --git a/docs/user-guide/installation/source/gnu-linux.md b/docs/user-guide/installation/source/gnu-linux.md new file mode 100644 index 00000000..5f9bd3e0 --- /dev/null +++ b/docs/user-guide/installation/source/gnu-linux.md @@ -0,0 +1,29 @@ +# GNU/Linux + +- You need to have cmake, and a c++ compiler + +*hint: you can use https://github.com/aminya/setup-cpp to install it* + +- Git clone the project or download the .zip + +`git clone -b main https://github.com/X-R-G-B/R-Bus.git R-Bus-main` + +**OR** + +`wget https://github.com/X-R-G-B/R-Bus/archive/main.zip && unzip R-Bus-main.zip` + +- Change directory + +`cd R-Bus-main || "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'"` + +- Install dependencies + +`sudo ./scripts/install-deps-linux.sh` + +- Build the project + +`./scripts/compil.sh` + +Well Done you have your binaries! + +Now, you can run it but dont move it anywhere diff --git a/docs/user-guide/installation/source/macos.md b/docs/user-guide/installation/source/macos.md new file mode 100644 index 00000000..f423f39e --- /dev/null +++ b/docs/user-guide/installation/source/macos.md @@ -0,0 +1,29 @@ +# MacOs + +- You need to have cmake, and a c++ compiler + +*hint: you can use https://github.com/aminya/setup-cpp to install it* + +- Git clone the project or download the .zip + +`git clone -b main https://github.com/X-R-G-B/R-Bus.git R-Bus-main` + +**OR** + +`wget https://github.com/X-R-G-B/R-Bus/archive/main.zip && unzip R-Bus-main.zip` + +- Change directory + +`cd R-Bus-main || "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'"` + +- Install dependencies + +`./scripts/install-deps-macos.sh` + +- Build the project + +`./scripts/compil.sh` + +Well Done you have your binaries! + +Now, you can run it but dont move it anywhere diff --git a/docs/user-guide/installation/source/windows.md b/docs/user-guide/installation/source/windows.md new file mode 100644 index 00000000..f7a8fab0 --- /dev/null +++ b/docs/user-guide/installation/source/windows.md @@ -0,0 +1,29 @@ +# Windows + +- You need to have cmake, and a c++ compiler + +*hint: you can use https://github.com/aminya/setup-cpp to install it* + +- Git clone the project or download the .zip + +`git clone -b main https://github.com/X-R-G-B/R-Bus.git R-Bus-main` + +**OR** + +`wget https://github.com/X-R-G-B/R-Bus/archive/main.zip && unzip R-Bus-main.zip` + +- Change directory + +`cd R-Bus-main || "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'"` + +- Install dependencies + +`./scripts/install-deps-windows.ps1` + +- Build the project + +`./scripts/compil.ps1` + +Well Done you have your binaries! + +Now, you can run it but dont move it anywhere diff --git a/scripts/bundle-linux.sh b/scripts/bundle-linux.sh index 0c884415..60d1ec25 100755 --- a/scripts/bundle-linux.sh +++ b/scripts/bundle-linux.sh @@ -11,8 +11,8 @@ cd build || exit 14 cpack --config CPackConfig.cmake -G STGZ -mv R-Type-*-Linux.sh ../r-type-linux.sh +mv R-Type-Linux.sh ../r-type-linux.sh cpack --config CPackSourceConfig.cmake -G TGZ -mv R-Type-*-Source.tar.gz ../r-type-linux.tar.gz +mv R-Type-Source.tar.gz ../r-type-linux.tar.gz diff --git a/scripts/bundle-windows.ps1 b/scripts/bundle-windows.ps1 index eb9acc09..e947bd67 100644 --- a/scripts/bundle-windows.ps1 +++ b/scripts/bundle-windows.ps1 @@ -17,10 +17,10 @@ if ($LASTEXITCODE -ne 0) { type _CPack_Packages/win64/NSIS/NSISOutput.log } -Copy-Item R-Type-*-win64.exe ../r-type-windows.exe +Copy-Item R-Type-win64.exe ../r-type-windows.exe cpack --config CPackSourceConfig.cmake -G ZIP -Copy-Item R-Type-*-Source.zip ../r-type-windows.zip +Copy-Item R-Type-Source.zip ../r-type-windows.zip cd ..