|
4 | 4 | [](https://github.com/theRookieCoder/ferium/blob/main/LICENSE.txt)
|
5 | 5 | [](https://en.wikipedia.org/wiki/Copyleft)
|
6 | 6 |
|
7 |
| -Ferium is an open source and easy to use package manager for Minecraft mods on [Modrinth](https://modrinth.com) and [GitHub Releases](https://github.com/releases). Simply specify the mods you use through the CLI and in just one command, you can download all the mods and update existing ones. |
| 7 | +Ferium is an easy to use CLI program for managing Minecraft mods from [Modrinth](https://modrinth.com/mods), [CurseForge](https://curseforge.com/minecraft/mc-mods), and [GitHub Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases). Simply specify the mods you use through the CLI and in just one command, you can download all the mods and update existing ones. |
8 | 8 |
|
9 |
| -## Feature requests |
| 9 | +## Feature Requests |
10 | 10 |
|
11 |
| -If you want to have a feature added, check the [project](https://github.com/theRookieCoder/ferium/projects/1) to see if the feature is already added/planned. If not, you can [create a new issue](https://github.com/theRookieCoder/ferium/issues/new) |
| 11 | +If you would like to make a feature request, check the [project](https://github.com/theRookieCoder/ferium/projects/1) to see if the feature has already been added/planned. If not, you can [create a new issue](https://github.com/theRookieCoder/ferium/issues/new) |
12 | 12 |
|
13 |
| -## Building or working on Ferium |
| 13 | +## Building or Working with Ferium |
14 | 14 |
|
15 |
| -First you have to install the Rust toolchain (`cargo`, `rustup`, etc). |
16 |
| -To build the project and install it to `~/bin`, run `make install`. If you want to test the project by yourself, you can use `make install-dev` which is `make install` but compiles with `--debug`. |
17 |
| -If you want to obtain executables for a specific OS, you can run `make build-<OS>` and replace `<OS>` with `mac`, `win`, or `linux`. The produced binaries will be zipped and moved to `out/`. |
18 |
| -You can also run unit and integration tests using `make test`. The reason we don't use `cargo test` is that it will interfere with your existing config, and the integration tests do not work when run in parallel. `make test` saves your config, forces tests to run sequentially, then restores your config (whether the tests failed or not). |
| 15 | +Firstly you need the Rust toolchain (`cargo`, `rustup`, etc). You can install these from <https://rust-lang.org>. |
| 16 | +To build the project and install it to `~/bin`, clone the project then run `make install`. If you want to install for testing a developement version, use `make install-dev` <sup>(which is just `make install` but with `--debug`)</sup>. |
| 17 | +If you want to obtain executables for a specific OS, you can run `make build-<OS>` and replace `<OS>` with `mac`, `win`, or `linux`. The produced binaries will be zipped and moved to `out/`. |
| 18 | +You can run tests using `make test`. Don't use `cargo test` because that will interfere with your existing config, and the integration tests do not work when run in parallel. `make test` saves your config, forces tests to run sequentially, then restores your config (whether the tests failed or not). |
0 commit comments