~mhueschen/uncap

195c2dc19b72957cc59386020f7931ffbf67c68d — Michael Hueschen 1 year, 2 months ago 863f998
readme: stylize lowercase
1 files changed, 10 insertions(+), 8 deletions(-)

M README.adoc
M README.adoc => README.adoc +10 -8
@@ 1,17 1,19 @@
= UNCAP
= uncap

A small utility built as a learning exercise for using Haskell with Nix.
a small text un/capitalization utility.

built as a learning exercise for using Haskell with Nix.

'''

== Building
== building

[source,shell]
----
nix build
----

=== Running
=== running

[source]
----


@@ 25,7 27,7 @@ commands below expect to be run inside of a nix dev shell.

either run `nix develop` (requires https://nixos.wiki/wiki/Flakes[Flakes]), run `nix-shell` (using legacy nix), or use https://github.com/nix-community/nix-direnv[nix-direnv].

== Keeping `uncap.nix` (cabal2nix) up to date
== keeping `uncap.nix` (cabal2nix) up to date

please do this after modifying source, so that dependencies are updated.



@@ 34,7 36,7 @@ please do this after modifying source, so that dependencies are updated.
cabal2nix . > uncap.nix
----

== Rendering README locally
== rendering README locally

[source,shell]
----


@@ 42,9 44,9 @@ cabal2nix . > uncap.nix
asciidoctor README.adoc
----

This defaults to outputting `.html`.
this defaults to outputting `.html`.

== Unrelated general-Nix-project stuff I don't want to forget
== unrelated general-Nix-project stuff I don't want to forget

[source,shell]
----