From 09bb85af43d72c0e7c096f97d2e0919332f3bdcc Mon Sep 17 00:00:00 2001 From: Gin <65128789+GinOwO@users.noreply.github.com> Date: Mon, 2 Oct 2023 20:30:53 +0530 Subject: [PATCH] Workflow Fix * workflow fix * workflow fix * workflow fix * workflow fix * update readme * update readme --- .github/workflows/c-cpp-build-linux.yaml | 5 +- .github/workflows/c-cpp-build-windows.yaml | 18 +++---- LICENSE | 37 +++++++------ README.md | 63 +++++++++++++++++++++- 4 files changed, 90 insertions(+), 33 deletions(-) diff --git a/.github/workflows/c-cpp-build-linux.yaml b/.github/workflows/c-cpp-build-linux.yaml index f876963..15f1dcc 100644 --- a/.github/workflows/c-cpp-build-linux.yaml +++ b/.github/workflows/c-cpp-build-linux.yaml @@ -1,9 +1,6 @@ name: Build Linux -on: - push: - branches: - - main +on: push env: QT_VERSION: "6.5.0" diff --git a/.github/workflows/c-cpp-build-windows.yaml b/.github/workflows/c-cpp-build-windows.yaml index f7b2837..d67d244 100644 --- a/.github/workflows/c-cpp-build-windows.yaml +++ b/.github/workflows/c-cpp-build-windows.yaml @@ -1,9 +1,6 @@ name: Build Windows -on: - push: - branches: - - main +on: push env: QT_VERSION: "6.5.0" @@ -19,16 +16,15 @@ jobs: - name: Checkout code uses: actions/checkout@v3 - - name: Set up MSVC - uses: ilammy/msvc-dev-cmd@v1.12.1 - - name: Install Qt uses: jurplel/install-qt-action@v3 with: - version: ${{ env.QT_VERSION }} - host: "windows" - target: "desktop" - arch: "win64_msvc2019_64" + aqtversion: '==3.1.*' + version: '6.5.0' + host: 'windows' + target: 'desktop' + arch: 'win64_mingw' + tools: 'tools_cmake tools_ninja' cache: 'true' - name: Install Ninja diff --git a/LICENSE b/LICENSE index cc4e314..fdddb29 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,24 @@ -MIT License +This is free and unencumbered software released into the public domain. -Copyright (c) 2023 Gin +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +For more information, please refer to diff --git a/README.md b/README.md index 41aff4e..71d97d6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,63 @@ # Caelum -[![LICENSE](https://img.shields.io/github/license/GinOwO/Caelum?color=blue)](LICENSE) ![Language](https://img.shields.io/badge/Language-C%2B%2B-brightgreen) ![Qt](https://img.shields.io/badge/Qt-6.5.0-brightgreen) ![GitHub csize](https://img.shields.io/github/languages/code-size/GinOwO/Caelum) [![Build Linux](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-linux.yaml/badge.svg?branch=main&event=push)](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-linux.yaml) [![Build Windows](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-windows.yaml/badge.svg?branch=main&event=push)](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-windows.yaml) +[![LICENSE](https://img.shields.io/github/license/GinOwO/Caelum?color=blue)](LICENSE) ![Language](https://img.shields.io/badge/Language-C%2B%2B-brightgreen) ![Qt](https://img.shields.io/badge/Qt-6.5.0-brightgreen) ![GitHub csize](https://img.shields.io/github/languages/code-size/GinOwO/Caelum) [![Build Linux](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-linux.yaml/badge.svg?event=push)](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-linux.yaml) [![Build Windows](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-windows.yaml/badge.svg?event=push)](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-windows.yaml) + +WIP + +## Downloading + +To use the pre-built binaries follow the steps below + +### Linux + +Download `Caelum_Linux_x86_64.tar.gz` from releases and extract the contents to a folder. Then run `/DistributionKit/Caelum.sh` + +### Windows + +Download `Caelum_Windows_x86_64.zip` from releases and extract the contents to a folder. Then run `Caelum.exe` + +## Building From Source + +### Prerequisites + +To build Caelum, you require the following on your system: + +- C++20 or above (MSVC will fail to build so go for GNU GCC) +- Qt framework 6.5.0+ +- Qt Creator Community 10.0.0+ +- (Optional: Linux Building only) [CQtDeployer](https://github.com/QuasarApp/CQtDeployer) + +### Cloning + +Open a command line in your desired folder, clone the repo with the following command +``` +git clone https://github.com/KThankYou/Caelum.git +``` + +## Building + +### Windows +1. Open Qt Creator and load the project. +2. Switch to release and then build the project. +3. Copy the release exe from the build folder to your desired folder. +4. Open a command line in your bin folder in the Qt installation, ex: `"D:\Qt\6.5.*\mingw_64\bin"` +5. Use the `set PATH=;%PATH%` to use the Qt DLLs, ex:`set PATH=D:\Qt\Tools\mingw1120_64\bin;%PATH%` +6. Now run the `windeployqt6 ""` command to copy necessary DLLs to the exe folder, ex: `windeployqt6 "D:\Caelum\Caelum.exe"` + +### Linux +1. Open Qt Creator and load the project. +2. Switch to release and then build the project. +3. Copy the release build from the build folder to your desired folder. +4. Open a terminal in the folder and copy the necessary files with CQtDeployer using `cqtdeployer -bin Caelum -qmake /path/to/Qt/6.5.*/gcc_64/bin/qmake` + +## Usage +WIP + +## Notes +WIP + +## Contributing +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on contributing to this project. + +## License + +This project is licensed under [The Unlicense](LICENSE).