diff --git a/BUILDING.md b/BUILDING.md index ad38027..3af86dc 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,20 +1,20 @@ # 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 - * Windows, macOS and other systems may work but are currently unsupported. -* CMake 3.25 or later -* Qt 5.15 or later -* Rust +* [Linux](https://kernel.org/) + * Windows, macOS and other systems may work but are currently unsupported. Patches are accepted to fix any problems with those OSes though. +* [CMake](https://cmake.org) 3.25 or later +* [Qt](https://www.qt.io/) 6.6 or later +* [KDE Frameworks](https://develop.kde.org/products/frameworks/) 6 +* [Rust](https://www.rust-lang.org/) +* [Corrosion](https://github.com/corrosion-rs/corrosion) -## Configuring - -**Note:** Some dependencies will automatically be downloaded from the Internet if not found on your system. This functionality may change in the future. +### Configuring To configure, run `cmake` in the source directory: @@ -23,10 +23,10 @@ $ cd novus $ 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 -$ cmake -S . -B build -DSOME_OVERRIDE=ON +$ cmake -S . -B build -DENABLE_SOMETHING=ON ``` ## Building @@ -37,4 +37,4 @@ Now begin building the project: $ cmake --build build ``` -If the build was successful, you'll find each binary under their respective folder in `build/`. \ No newline at end of file +If the build was successful, the tool binaries will be found in `./build/bin`. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index d186359..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -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). diff --git a/README.md b/README.md index cc0de68..f62a9f6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![builds.sr.ht status](https://builds.sr.ht/~redstrate/novus.svg)](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. ![Screenshot of some of the applications](https://xiv.zone/novus.png) @@ -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. -## 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