-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* workflow fix * workflow fix * workflow fix * workflow fix * update readme * update readme
- Loading branch information
Showing
4 changed files
with
90 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,6 @@ | ||
| name: Build Linux | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| on: push | ||
|
|
||
| env: | ||
| QT_VERSION: "6.5.0" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <https://unlicense.org> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,63 @@ | ||
| # Caelum | ||
| [](LICENSE)    [](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-linux.yaml) [](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-windows.yaml) | ||
| [](LICENSE)    [](https://github.com/GinOwO/Caelum/actions/workflows/c-cpp-build-linux.yaml) [](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_qt>;%PATH%` to use the Qt DLLs, ex:`set PATH=D:\Qt\Tools\mingw1120_64\bin;%PATH%` | ||
| 6. Now run the `windeployqt6 "<path_to_exe>"` 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). |