Skip to content

Commit

Permalink
chore(readme): add detection list
Browse files Browse the repository at this point in the history
  • Loading branch information
ErrorNoInternet committed Aug 22, 2024
1 parent 66be34e commit e927501
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,24 @@
A fetch tool written in x86-64 assembly for Linux.
Runs in under 150 microseconds and has zero dependencies.

There is almost no error handling and lots of things may break.
Please report any bugs you find.

![Preview](/asmfetch.png)

## Detections

- username (`$USER`)
- hostname
- os name from `/etc/os-release`
- kernel
- name
- version
- architecture
- shell (`$SHELL`)
- uptime
- desktop (`$XDG_CURRENT_DESKTOP`)
- display backend (`$XDG_SESSION_TYPE`)
- memory usage
- disk usage for `/`

## Usage

```shell
Expand All @@ -17,6 +30,7 @@ $ ./asmfetch

## Customization

It wasn't designed to be very customizable or dynamic; tons of values
are hardcoded, but you can tweak one or two things (including the logo)
by modifying the includes in `asmfetch.S` and symbols in `symbols.S`.
asmfetch wasn't designed to be very customizable or dynamic; tons of
values (e.g. the logo, symbols, format, colors) are hardcoded. The
only way to change them is by modifying the source code, specifically
the `include`ed files in `asmfetch.S` and symbols in `symbols.S`.

0 comments on commit e927501

Please sign in to comment.