Initial commit

Makefile

@@ -0,0 +1,25 @@
+pkgname=neofetch-crystal
+_pkgname=neofetch
+
+PREFIX ?= /usr/local
+
+.PHONY: all install uninstall
+
+all:
+
+install:
+	install -Dm 755 "${pkgname}.sh" "${DESTDIR}${PREFIX}/bin/${_pkgname}"
+	gzip -c "${pkgname}.1" > "${pkgname}.1.gz"
+	install -Dm 644 "${pkgname}.1.gz" "${DESTDIR}${PREFIX}/share/man/man1/${_pkgname}.1.gz"
+	rm -f "${pkgname}.1.gz"
+	install -Dm 644 README.md "${DESTDIR}${PREFIX}/share/doc/${pkgname}/README.md"
+	install -Dm 644 LICENSE "${DESTDIR}${PREFIX}/share/licenses/${pkgname}/LICENSE.md"
+
+uninstall:
+	rm -f "${DESTDIR}${PREFIX}/bin/${_pkgname}"
+	rm -f "${DESTDIR}${PREFIX}/share/man/man1/${_pkgname}.1.gz"
+	rm -rf "${DESTDIR}${PREFIX}/share/doc/${pkgname}/"
+	rm -rf "${DESTDIR}${PREFIX}/share/licenses/${pkgname}/"
+
+test:
+	"./${pkgname}.sh" --help

README.md

@@ -1,3 +1,35 @@
-# neofetch-crystal
+<p align="center">
+  <a href="https://github.com/crystal-linux/neofetch-crystal/">
+    <img src="https://getcryst.al/site/assets/other/logo.png" alt="Logo" width="150" height="150">
+  </a>
+</p>
+<h2 align="center">Neofetch-Crystal</h2>
 
-Under construction
+<p align="center">Neofetch-Crystal is a fork of [neofetch](https://github.com/dylanaraps/neofetch) that includes the Crystal Linux logo.</p>
+<p align="center">It also serves as an updated version of the original `neofetch` since it seems unmaintained.</p>
+
+## Installation
+
+Neofetch-Crystal comes pre-installed with [Crystal Linux](https://getcryst.al/site) but it can be built on any other distributions.
+
+### From source
+
+**Neofetch-Crystal provides and conflicts `neofetch`**  
+**If you already have `neofetch` installed, please uninstall it before installing Neofetch-Crystal from source**  
+  
+Download the archive of the [latest stable release](https://github.com/crystal-linux/neofetch-crystal/releases/latest) and extract it.  
+*Alternatively, you can clone this repository via `git`.*  
+
+To install Neofetch-Crystal, go into the extracted/cloned directory and run the following command:  
+```
+sudo make install
+```
+
+### Arch Linux
+
+Arch Linux users (and Arch based distro users in general) can alternatively use the [PKGBUILD](https://github.com/crystal-linux-packages/neofetch-crystal/blob/main/PKGBUILD):  
+```
+git clone https://github.com/crystal-linux-packages/neofetch-crystal.git
+cd neofetch-crystal
+makepkg -si
+```