redstrate/astra
1
Fork 0
mirror of https://github.com/redstrate/Astra.git synced 2025-04-20 11:47:46 +00:00
Code Activity

Update README, BUILDING, CONTRIBUTING and add FUNDING.yml

Browse source
This commit is contained in:
Joshua Goins 2024-04-22 16:39:25 -04:00
parent 34c5ac6348
commit 7176de7b7a
4 changed files with 24 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/FUNDING.yml vendored Normal file
View file

@ -0,0 +1 @@
ko_fi: redstrate

16
BUILDING.md
View file

@ -45,12 +45,26 @@ These are optional dependencies, that will be used if found on your system.
* Gamemode * Gamemode
* Turn on `ENABLE_GAMEMODE` to enable integration. * 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 ### Configuring
To configure, run `cmake` in the source directory: To configure, run `cmake` in the source directory:
```bash ```bash
$ cd astra $ cd Astra
$ cmake -S . -B build $ cmake -S . -B build
``` ```

4
CONTRIBUTING.md
View file

@ -1,8 +1,6 @@
# Contributing to Astra # 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). 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).
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).
## What Needs Doing ## What Needs Doing

13
README.md
View file

@ -21,19 +21,16 @@ plugins!
Details on where to find stable releases of Astra can be found on its [homepage](https://xiv.zone/astra). 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 ## Building
Please refer to the [building document](BUILDING.md) for instructions on how to build Astra. 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 ## License