Skip to content

Commit

Permalink
Style README with classy mathy headers
Browse files Browse the repository at this point in the history
  • Loading branch information
booniepepper authored Sep 1, 2023
1 parent 5dffc30 commit 96eddf8
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<img align="right" src="img/bing-crosby.jpg" width="256">

# crozbi
# $crozbi$

## Clone RepO, Zig Build, Install
## $Clone$ $RepO, Zig$ $Build, Install$

Installer for _simple_ Zig-built-from-source executables.

Expand All @@ -15,7 +15,7 @@ stabilize and land in a Linux distro or something.

### [Wiki](https://github.com/so-dang-cool/crozbi/wiki)

## Usage
## $Usage$

```
crozbi 1.0
Expand Down Expand Up @@ -56,13 +56,13 @@ crozbi uninstall EXE
Uninstall EXE by deleting a symlink at $HOME/.local/bin/$EXE
```

## Requirements
## $Requirements$

1. [bash](https://www.gnu.org/software/bash/)
2. [git](https://git-scm.com/)
3. [zig](https://ziglang.org/)

## Installing
## $Installing$

The recommended way to install crozbi for the first time ever is to run something
like this in bash:
Expand All @@ -79,7 +79,7 @@ ln -s "$CROZBI_HOME/$CROZBI_REPO/zig-out/bin/crozbi" "$CROZBI_BIN/crozbi"

Minus a Zig build, that is basically everything crozbi does.

## Updating
## $Updating$

With crozbi installed, you can update to the most recent version with:

Expand All @@ -89,7 +89,7 @@ crozbi so-dang-cool/crozbi

If you've forked the repository, update the REPO argument as needed.

## Notes on safety and being excellent
## $Notes$ $on$ $safety$ $and$ $being$ $excellent$

The crozbi project makes zero guarantees of safety. Please be sure that you trust
a project before compiling it and executing it on your machine.
Expand All @@ -105,7 +105,7 @@ another package manager, using a different version of Zig than what you have
installed, requiring dependencies that aren't modeled, or having some difficult
to understand build process.)_

## Etc
## $Etc$

Released under the terms of the [BSD 3-Clause license]()

Expand Down

0 comments on commit 96eddf8

Please sign in to comment.