Merge pull request #123 from q60/main

Get rid of pandoc in favor of roff
This commit is contained in:
TheDarkBug 2021-08-27 21:52:16 +02:00 committed by GitHub
commit 79ad589901
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 114 additions and 126 deletions

1
.gitignore vendored
View file

@ -2,6 +2,5 @@ uwufetch
*.zip *.zip
*.idea *.idea
*.vscode *.vscode
*.1
.DS_STORE .DS_STORE
.prettierrc .prettierrc

View file

@ -18,8 +18,7 @@ else ifeq ($(shell uname), FreeBSD)
MANDIR = /usr/share/man/man1 MANDIR = /usr/share/man/man1
endif endif
CC = cc CC = cc
MAN_COMPILER = pandoc
build: $(FILES) build: $(FILES)
@ -51,10 +50,8 @@ termux_uninstall:
rm -rf $(DESTDIR)/data/data/com.termux/files/usr/lib/uwufetch/ rm -rf $(DESTDIR)/data/data/com.termux/files/usr/lib/uwufetch/
man: man:
$(MAN_COMPILER) $(NAME)_man.md -st man -o $(NAME).1 gzip --keep $(NAME).1
@gzip $(NAME).1
man_debug: man_debug:
$(MAN_COMPILER) $(NAME)_man.md -st man -o $(NAME).1
@clear @clear
@man -P cat ./uwufetch.1 man -P cat ./uwufetch.1

View file

@ -6,7 +6,7 @@ A meme system info tool for (almost) all your Linux/Unix-based systems, based on
### Full support (Both ASCII art + images are provided for the given distribution) ### Full support (Both ASCII art + images are provided for the given distribution)
Nyalpine, Nyarch Linuwu, Nyartix Linuwu, Debinyan, endOwO, Fedowa, GentOwO, GnUwU gUwUix, Miwint, Myanjawo, OwOpenSUSE, Pop OwOs, RaspNyan, Swackwawe, sOwOlus, UwUntu, and OwOid; Plus Nyandroid. Nyalpine, Nyarch Linuwu, Nyartix Linuwu, Debinyan, endevaOwO, Fedowa, GentOwO, GnUwU gUwUix, Miwint, Myanjawo, OwOpenSUSE, Pop OwOs, RaspNyan, Swackwawe, sOwOlus, UwUntu, and OwOid; Plus Nyandroid.
### Partial support (Either no ASCII art, or no image is provided) ### Partial support (Either no ASCII art, or no image is provided)
@ -36,7 +36,6 @@ Build requisites:
- Make - Make
- A C compiler - A C compiler
- `pandoc` to compile man pages
To install UwUfetch from the source, type these commands in the terminal: To install UwUfetch from the source, type these commands in the terminal:

110
uwufetch.1 Normal file
View file

@ -0,0 +1,110 @@
.\" A little documentation for future use
.\" This a comment
.\" TH request sets the title of the man page and the section (between 1 and 8)
.\" SH is a primary section heading
.\" TP sets up an indented paragraph with label
.\" B makes text appear in bold face
.\" I makes text appear in italic face
.\" inline versions would look like \fBthis\fR and \fIthis\fR
.\" EX and EE surrounds example section with text as is, with no empty lines in between the actual lines
.TH UWUFETCH 1 "27 August 2021" "1.4" "A meme system info tool for Linux"
.SH DESCRIPTION
UwUfetch is a program inspired by neofetch and ufetch, that takes system information and prints it in terminal in an UwU way, with either UwU ascii or image logo.
.SH SYNOPSYS
\fBuwufetch\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
.SH OPTIONS
.TP
.B -a --ascii
prints the logo as ascii text (default)
.TP
.B -c --config
you can change config path
.TP
.B -d --distro
you can choose the logo to print by the distro name
.TP
.B -h --help
prints a help page
.TP
.B -i --image
prints image instead of ascii logo uses a custom image if one is provided
.TP
.B -l --list
prints a list of all supported distributions
.SH CONFIGURATION
The config file is located in $HOME/.config/uwufetch/config (you need to create it), but you can change the path by using the \fB--config\fR option.
.TP
.SH EXAMPLE
.EX
distro=arch
image="~/Pictures/picture.png"
ascii=false
user=true
os=true
host=true
kernel=true
cpu=true
gpu=false
ram=true
resolution=true
shell=true
pkgs=true
uptime=true
colors=true
.EE
.SH SUPPORTED DISTRIBUTIONS
Distribution name -d \fBoption\fR
.TP
.SH FULLY SUPPORTED
.EX
Nyalpine \fBalpine\fR
Nyarch Linuwu \fBarch\fR
Nyartix Linuwu \fBartix\fR
Debinyan \fBdebian\fR
endeavOwO \fBendeavour\fR
Fedowa \fBfedora\fR
GentOwO \fBgentoo\fR
GnUwU gUwUix \fBguix\fR
Miwint \fBlinuxmint\fR
Myanjawo \fBmanjaro\fR
Myanjawo AWM \fBmanjaro-arm\fR
OwOpenSUSE \fBopensuse-leap\fR
Pop OwOs \fBpop\fR
RaspNyan \fBraspbian\fR
Swackwawe \fBslackware\fR
sOwOlus \fBsolus\fR
UwUntu \fBubuntu\fR
OwOid \fBvoid\fR
Nyandroid \fBandroid\fR
Unknown (tux logo) \fBunknown\fR
.EE
.TP
.SH IMAGE OR ASCII ONLY
.EX
KDE NeOwOn \fBneon\fR
nixOwOs \fBnixos\fR
FweeBSD \fBfreebsd\fR
OwOpenBSD \fBopenbsd\fR
macOwOS \fBmacos\fR
WinyandOwOws \fBwindows\fR
.EE
.SH EXAMPLES
.EX
uwufetch -d arch # uses ascii Arch logo
uwufetch --custom some_image.png # prints custom image (no full path is needed)
uwufetch -i -d artix # uses Artix image logo (which is also uwu)
.EE
.SH DEPENDENCIES
.TP 8
.B lshw
better gpu info
.TP
.B viu
print images instead of ascii logo
.TP
.B kitty
better image viewing
.P
All of these dependencies are optional. There are no required dependencies.
.SH LICENSE AND COPYRIGHT
uwufetch is provided under the GPL3 license, for copyright info read https://github.com/TheDarkBug/uwufetch/tree/main/res/COPYRIGHT.md.

Binary file not shown.

View file

@ -1,117 +0,0 @@
% UWUFETCH(1) uwufetch 1.4
% TheDarkBug
% April 2021
<!---
I am using markdown instead of troff because i don't know how to use it, and the same could be for some people.
I also don't know if this is a good practice, but it works, so I am keeping it.
To "compile" this file you need pandoc (https://pandoc.org).
--->
# NAME
uwufetch - A meme system info tool for Linux, based on nyan/uwu trend on r/linuxmasterrace.
# SYNOPSIS
**uwufetch** [*OPTIONS*] [*ARGUMENTS*]
# OPTIONS
-a --ascii\
prints the logo as ascii text (default)
-c --config\
you can change config path
-d --distro\
you can choose the logo to print by the distro name
-h --help\
prints a help page
-i --image\
prints image instead of ascii logo\
uses a custom image if one is provided
-l --list\
prints a list of all supported distributions
# CONFIG FILE
The config file is located in $HOME/.config/uwufetch/config (you need to create it), but you can change the path by using the `--config` option.
## EXAMPLE:
distro=arch\
image="~/Pictures/picture.png"\
ascii=false\
user=true\
os=true\
host=true\
kernel=true\
cpu=true\
gpu=false\
ram=true\
resolution=true\
shell=true\
pkgs=true\
uptime=true\
colors=true
# SUPPORTED DISTRIBUTIONS
Distribution name\ \ \ \ \ -d option
Nyalpine\ \ \ \ \ \ \ \ \ alpine\
Nyarch Linuwu\ \ \ \ \ \ \ arch\
Nyartix Linuwu\ \ \ \ \ \ \ artix\
Debinyan\ \ \ \ \ \ \ \ \ debian\
Fedowa\ \ \ \ \ \ \ \ \ \ \ fedora\
GentOwO\ \ \ \ \ \ \ \ \ \ gentoo\
GnUwU gUwUix\ \ \ \ \ \ \ guix\
Miwint\ \ \ \ \ \ \ \ \ \ \ linuxmint\
Myanjawo\ \ \ \ \ \ \ \ \ manjaro\
Myanjawo AWM\ \ \ \ \ \ \ \\"manjaro-arm\\"\
OwOpenSUSE\ \ \ \ \ \ \ \ \ \\"opensuse-leap\\"\
Pop OwOs\ \ \ \ \ \ \ \ \ pop\
RaspNyan\ \ \ \ \ \ \ \ \ raspbian\
UwUntu\ \ \ \ \ \ \ \ \ \ \ ubuntu\
OwOid\ \ \ \ \ \ \ \ \ \ \ \\"void\\"\
Nyandroid\ \ \ \ \ \ \ \ \ android\
Unknown (tux logo)\ \ \ \ \ unknown
--image/ascii only distributions--\
endeavOwO\ \ \ \ \ \ \ \ \ endeavour\
KDE NeOwOn\ \ \ \ \ \ \ \ \ neon\
nixOwOs\ \ \ \ \ \ \ \ \ \ nixos\
Swackwawe\ \ \ \ \ \ \ \ \ slackware\
sOwOlus\ \ \ \ \ \ \ \ \ \ solus\
FweeBSD\ \ \ \ \ \ \ \ \ \ freebsd\
OwOpenBSD\ \ \ \ \ \ \ \ \ openbsd\
macOwOS\ \ \ \ \ \ \ \ \ \ macos\
WinyandOwOws\ \ \ \ \ \ \ windows
# DESCRIPTION
UwUfetch is a program inspired by neofetch and ufetch, that takes system informations\
and prints them in the terminal in an UwU way, with and UwU ascii logo or image.
# EXAMPLES
uwufetch -d arch\ \ \ \ \ \ \ \ \ \ # prints arch logo\
uwufetch -\-custom some_image.png\ \ # prints custom image (does not need full path)\
ueufetch -i -d artix\ \ \ \ \ \ \ \ # prints artix image
# DEPENDENCIES
lshw\ \ \ better gpu info\
viu\ \ \ \ print images instead of ascii logo\
kitty\ \ \ better image viewing
All of these dependencies are optional. There are no required dependencies.
# LICENSE AND COPYRIGHT
uwufetch is provided under the GPL3 license, for copyright info read\
https://github.com/TheDarkBug/uwufetch/tree/main/res/COPYRIGHT.md.