diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..61b0227 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +ko_fi: redstrate diff --git a/BUILDING.md b/BUILDING.md index 8421580..b468b9c 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -45,12 +45,26 @@ These are optional dependencies, that will be used if found on your system. * Gamemode * Turn on `ENABLE_GAMEMODE` to enable integration. +### Getting source code + +Astra has git submodules that must be cloned alongside the repository, so make sure to pass the `--recursive` flag: + +```bash +$ git clone --recursive https://github.com/redstrate/Astra.git +``` + +If you missed it, it's possible to initialize the submodules afterward: + +```bash +$ git submodule update --init --recursive +``` + ### Configuring To configure, run `cmake` in the source directory: ```bash -$ cd astra +$ cd Astra $ cmake -S . -B build ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e47123..0ed5661 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,6 @@ # Contributing to Astra -I appreciate any code contributions to Astra, whether they are bugfixes or new features! this repository is managed on [sourcehut](https://git.sr.ht/~redstrate/astra). - -Once you finished your changes, use [git send-email](https://git-send-email.io/) or the [sourcehut web contributor interface](https://git.sr.ht/~redstrate/astra/send-email) to upload them. Please send your patches to [~redstrate/public-inbox@lists.sr.ht](mailto:~redstrate/public-inbox@lists.sr.ht). +I appreciate any code contributions to Astra, whether they are bugfixes or new features! this repository is managed on [GitHub](https://github.com/redstrate/Astra). ## What Needs Doing @@ -22,4 +20,4 @@ The user interface is written in QML, using technologies such as Kirigami. Pleas ## Conventions -Astra follows the standard KDE coding style, which is enforced by the use of [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and a git hook. There is nothing else you need to do, please commit any fixes the tool makes. \ No newline at end of file +Astra follows the standard KDE coding style, which is enforced by the use of [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and a git hook. There is nothing else you need to do, please commit any fixes the tool makes. diff --git a/README.md b/README.md index cf87a5d..5018cd5 100644 --- a/README.md +++ b/README.md @@ -21,22 +21,19 @@ plugins! Details on where to find stable releases of Astra can be found on its [homepage](https://xiv.zone/astra). -Distribution packaging is encouraged, so please send an [email through the mailing list](https://lists.sr.ht/~redstrate/public-inbox) for any concerns. - -## Support - -If you have an issue with Astra, please [email the mailing list](https://lists.sr.ht/~redstrate/public-inbox). - ## Building Please refer to the [building document](BUILDING.md) for instructions on how to build Astra. -## Contributing +## Contributing & Support -Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to Novus. +The best way you can help is by [monetarily supporting me](https://redstrate.com/fund/) or by submitting patches to +help fix bugs or add functionality. Filing issues is appreciated, but I do this in my free time so please don't expect professional support. + +Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to Astra. ## License ![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png) -This project is licensed under the [GNU General Public License 3](LICENSE). Some code or assets may be licensed differently, please refer to the [REUSE](https://reuse.software/spec/) metadata. \ No newline at end of file +This project is licensed under the [GNU General Public License 3](LICENSE). Some code or assets may be licensed differently, please refer to the [REUSE](https://reuse.software/spec/) metadata.