Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme
Browse files Browse the repository at this point in the history
sebastian-j-ibanez committed Jan 24, 2025
1 parent ea175c9 commit 68d39da
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Hexd 🔍
# hexd 🔍
![GitHub License](https://img.shields.io/github/license/sebastian-j-ibanez/hexd?color=red)

Hexd is a CLI program that outputs a hexdump of binary files.
hexd is a CLI program that creates hex dumps.

## Usage
`hexd [file]`

## Building the project
The project can be built with `make`. The `hexd` binary will be generated in the build folder.
The project is built using `make`. The default `make` target will create a `hexd` binary in the build folder.

***Note:*** If you use clangd, it is recommended to generate clangd config files with [compiledb](https://github.com/nickdiego/compiledb/tree/master).

## Purpose
I'm writing hexd to learn more about binary files. It's also an opportunity for me to write more C.

0 comments on commit 68d39da

Please sign in to comment.