Fix CI for real, update README
This commit is contained in:
parent
b900d28f77
commit
92ce996654
31
README.md
31
README.md
@ -40,7 +40,7 @@ Currently, only Windows (x86_64, gnu/msvc) and Linux (x86_64/aarch64, gnu/musl)
|
||||
|
||||
### Dependencies
|
||||
|
||||
#### Build/Install
|
||||
#### Build/install
|
||||
|
||||
To build Oxidefetch, you need Cargo. If you do not already have Cargo installed on your system, you can do so by installing Rustup- either via the [instructions on their website](https://doc.rust-lang.org/cargo/getting-started/installation.html "instructions on their website") or via your system package manager.
|
||||
You will also probably need a C/C++ compiler and a build system- most likely CMake and Visual Studio Build Tools, or GNU Make and the GNU compiler collection. You will be prompted to install these if they're not found during compilation.
|
||||
@ -53,33 +53,7 @@ From there, it *should* be in your `$PATH`. If not, add `source ~/.cargo/env` to
|
||||
|
||||
The only runtime dependency for this project is a font with Nerd Fonts Symbols. If this is not used, the symbols in the output will not appear correctly.
|
||||
|
||||
### How you can help with the project
|
||||
|
||||
I need to verify the output of the OS information detection libraries I'm pulling in. To do this, I need the help of people with varying types of systems. I've tested a few, but there's some I'm unable to test. To help, you can kindly clone this repo, and inside the folder, run `cargo test -- --nocapture`, and send the resultant `test_output.txt` file to my noreply email address, or directly to me on Discord at `@shibedrill`. This program does NOT collect information regarding your real name, IP, location, hardware serial numbers, etc. You can look at the file it generates to be sure- it's all plaintext, babey. Also, consider contributing to [libpci-rs](https://github.com/namedneon/libpci-rs) to improve its functionality, efficiency, and cleanliness.
|
||||
|
||||
#### Tested distributions/platforms
|
||||
|
||||
- Alma Linux
|
||||
- Alpine Linux
|
||||
- Android
|
||||
- Arch Linux
|
||||
- CentOS
|
||||
- Debian GNU/Linux
|
||||
- Fedora
|
||||
- Gentoo
|
||||
- Kali GNU/Linux
|
||||
- Linux Mint
|
||||
- openSUSE Leap
|
||||
- openSUSE Tumbleweed
|
||||
- Ubuntu
|
||||
- Windows
|
||||
|
||||
### Bugs, Quirks, Unintended Behavior, And Other Shenanigans
|
||||
|
||||
- Some information may be vague or incorrect on Android. I might consider switching to new stacks for certain pieces of information.
|
||||
- GPU detection might require root on certain platforms, such as Android and MacOS.
|
||||
|
||||
### To Do & Roadmap
|
||||
### Todo & roadmap
|
||||
|
||||
#### Semi-urgent fixes
|
||||
|
||||
@ -130,6 +104,7 @@ I need to verify the output of the OS information detection libraries I'm pullin
|
||||
**2.0.0-beta.2:** Updated use of `libpci-rs` as its API approaches stability.
|
||||
**2.0.0-beta.3:** GPU subsystem names will display instead of long names, if available.
|
||||
**2.0.0-beta.4:** Added NixOS as a recognized distro.
|
||||
**2.0.0**: Finally merge libpci-rs branch to main
|
||||
|
||||
### License
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user