mirror of
https://github.com/redstrate/Novus.git
synced 2025-06-08 06:07:46 +00:00
Remove CONTRIBUTING (merge it into README) and fix BUILDING instructions
This commit is contained in:
parent
0245e15ddf
commit
a443c66a3f
3 changed files with 18 additions and 22 deletions
28
BUILDING.md
28
BUILDING.md
|
@ -1,20 +1,20 @@
|
||||||
# Building Novus
|
# Building Novus
|
||||||
|
|
||||||
## Dependencies
|
Currently the only way to build Novus is manually.
|
||||||
|
|
||||||
### Required
|
## Manual
|
||||||
|
|
||||||
All of these packages are required for Astra to build with a minimal set of features.
|
### Dependencies
|
||||||
|
|
||||||
* Linux
|
* [Linux](https://kernel.org/)
|
||||||
* Windows, macOS and other systems may work but are currently unsupported.
|
* Windows, macOS and other systems may work but are currently unsupported. Patches are accepted to fix any problems with those OSes though.
|
||||||
* CMake 3.25 or later
|
* [CMake](https://cmake.org) 3.25 or later
|
||||||
* Qt 5.15 or later
|
* [Qt](https://www.qt.io/) 6.6 or later
|
||||||
* Rust
|
* [KDE Frameworks](https://develop.kde.org/products/frameworks/) 6
|
||||||
|
* [Rust](https://www.rust-lang.org/)
|
||||||
|
* [Corrosion](https://github.com/corrosion-rs/corrosion)
|
||||||
|
|
||||||
## Configuring
|
### Configuring
|
||||||
|
|
||||||
**Note:** Some dependencies will automatically be downloaded from the Internet if not found on your system. This functionality may change in the future.
|
|
||||||
|
|
||||||
To configure, run `cmake` in the source directory:
|
To configure, run `cmake` in the source directory:
|
||||||
|
|
||||||
|
@ -23,10 +23,10 @@ $ cd novus
|
||||||
$ cmake -S . -B build
|
$ cmake -S . -B build
|
||||||
```
|
```
|
||||||
|
|
||||||
This command will create a new build directory and configure the source directory (`.`). If you want to enable more options, pass the mnow:
|
This command will create a new build directory and configure the source directory (`.`). If you want to enable more options, pass them now:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ cmake -S . -B build -DSOME_OVERRIDE=ON
|
$ cmake -S . -B build -DENABLE_SOMETHING=ON
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
@ -37,4 +37,4 @@ Now begin building the project:
|
||||||
$ cmake --build build
|
$ cmake --build build
|
||||||
```
|
```
|
||||||
|
|
||||||
If the build was successful, you'll find each binary under their respective folder in `build/`.
|
If the build was successful, the tool binaries will be found in `./build/bin`.
|
|
@ -1,5 +0,0 @@
|
||||||
# Contributing to Novus
|
|
||||||
|
|
||||||
I appreciate any code contributions to Novus, whether they are bugfixes or new features! this repository is managed on [sourcehut](https://git.sr.ht/~redstrate/novus).
|
|
||||||
|
|
||||||
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/novus/send-email) to upload them. Please send your patches to [~redstrate/public-inbox@lists.sr.ht](mailto:~redstrate/public-inbox@lists.sr.ht).
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
[](https://builds.sr.ht/~redstrate/novus)
|
[](https://builds.sr.ht/~redstrate/novus)
|
||||||
|
|
||||||
A suite of unofficial FFXIV modding tools, including a model viewer and data archive explorer.
|
A suite of unofficial FFXIV tools, including a model viewer and data archive explorer.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
@ -21,9 +21,10 @@ Here is an exhaustive list of tooling available here:
|
||||||
|
|
||||||
Please refer to the [building document](BUILDING.md) for instructions on how to build Novus.
|
Please refer to the [building document](BUILDING.md) for instructions on how to build Novus.
|
||||||
|
|
||||||
## 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.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue