mirror of
https://git.ari.lt/ari/badapplefetch.git
synced 2025-04-20 07:53:41 -05:00
Compare commits
6 commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
006b183ec2 | ||
![]() |
47787b1575 | ||
![]() |
a21c32984c | ||
![]() |
d9549216e8 | ||
![]() |
b7de7df285 | ||
![]() |
be63883f03 |
2 changed files with 49 additions and 2 deletions
38
CONTRIBUTING.md
Normal file
38
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
# Contribution guidelines
|
||||||
|
|
||||||
|
This document defines the contribution guidelines of this project.
|
||||||
|
|
||||||
|
## Adding a new logo
|
||||||
|
|
||||||
|
If you want to add a new logo, please keep these things in mind:
|
||||||
|
|
||||||
|
- The file name is case-insensitive, but it should be lowercase
|
||||||
|
- The file name defines the distribution of the OS
|
||||||
|
- The file name is matched case-insensitively and with a starts with function, meaning a string like "arch" would match "Arch Linux"
|
||||||
|
- In the content of the logo only the `\033` escape (ANSI escape) is interpreted. Everything else is treated as literal
|
||||||
|
- The logo must be small
|
||||||
|
|
||||||
|
## Changing/adding code
|
||||||
|
|
||||||
|
- Please stick to the formatting, use autoformatters (such as clang-format)
|
||||||
|
- Test your code
|
||||||
|
- Stick to the C99 standard
|
||||||
|
- Your code must also compile and fully work with the following flags set:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export STRIP=llvm-strip
|
||||||
|
export STRIPFLAGS='--strip-debug --strip-sections --strip-unneeded -T --remove-section=.note.gnu.gold-version --remove-section=.note --strip-all --discard-locals --remove-section=.gnu.version --remove-section=.eh_frame --remove-section=.note.gnu.build-id --remove-section=.note.ABI-tag --strip-symbol=__gmon_start__ --strip-all-gnu --remove-section=.comment --remove-section=.eh_frame_ptr --discard-all'
|
||||||
|
export CC=clang
|
||||||
|
export CFLAGS='-Wpedantic -flto=full -fno-trapping-math -fstrict-aliasing -fno-math-errno -fno-stack-check -fno-strict-overflow -funroll-loops -fno-stack-protector -fvisibility-inlines-hidden -mfancy-math-387 -fomit-frame-pointer -fstrict-overflow -Wshadow -fno-exceptions -D_FORTIFY_SOURCE=0 -Wall -Wextra -fno-signed-zeros -fno-strict-aliasing -pedantic -Ofast -fvisibility=hidden -ffast-math -funsafe-math-optimizations -std=c99 -fno-asynchronous-unwind-tables -Werror -fdiscard-value-names -femit-all-decls -fmerge-all-constants -fno-use-cxa-atexit -fno-use-init-array -march=native -mtune=native -pedantic-errors'
|
||||||
|
export LIBMPV=1
|
||||||
|
export FPS=30
|
||||||
|
```
|
||||||
|
|
||||||
|
`NOQA` must not be set. (`unset NOQA`)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
make purge
|
||||||
|
make -j$(nproc --all)
|
||||||
|
make strip
|
||||||
|
./badapplefetch # Should run the whole length of the song without crashing
|
||||||
|
```
|
13
README.md
13
README.md
|
@ -13,7 +13,6 @@ As the creator of Neofetch has [picked up farming](https://github.com/dylanaraps
|
||||||
- yt-dlp or youtube-dl (for downloading videos off YouTube, you can change that with `YT=...`)
|
- yt-dlp or youtube-dl (for downloading videos off YouTube, you can change that with `YT=...`)
|
||||||
- LibMPV & Libpthread (if you have `LIBMPV=1`)
|
- LibMPV & Libpthread (if you have `LIBMPV=1`)
|
||||||
- BASH
|
- BASH
|
||||||
- `od` utility (for audio)
|
|
||||||
|
|
||||||
# Compiling
|
# Compiling
|
||||||
|
|
||||||
|
@ -27,11 +26,21 @@ So, basically:
|
||||||
|
|
||||||
LIBMPV=1 make -j$(nproc --all)
|
LIBMPV=1 make -j$(nproc --all)
|
||||||
|
|
||||||
Should be enough for most people
|
Should be enough for most people. For more optimized flags see [CONTRIBUTING.md](/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
# Forks
|
||||||
|
|
||||||
|
- "Skibidi Toilet... In a fetch script" by Zayd: https://git.inamatrix.xyz/zayd/skibidifetch
|
||||||
|
|
||||||
# Credits
|
# Credits
|
||||||
|
|
||||||
- The video used for audio and video: <https://www.youtube.com/watch?v=FtutLA63Cp8>
|
- The video used for audio and video: <https://www.youtube.com/watch?v=FtutLA63Cp8>
|
||||||
|
- Logos mainly extracted from: <https://github.com/dylanaraps/pfetch>
|
||||||
|
|
||||||
|
# Logo
|
||||||
|
|
||||||
|
- If you want a specific logo to show up, supply it in the command line of BadAppleFetch, such as `./badapplefetch ubuntu`
|
||||||
|
- If you want to add a logo, please see [CONTRIBUTING.md](/CONTRIBUTING.md)
|
||||||
|
|
||||||
# Screenshot
|
# Screenshot
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue