aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-11-10 22:29:50 +1300
committerTom Ryder <tom@sanctum.geek.nz>2018-11-10 22:30:03 +1300
commit4637f6697e2c308be6dc41cda60074106a0f4929 (patch)
tree00c4d8e921bb425761c97892248b958dbf080aba /README.md
parentType is_utf8_cont for clarity (diff)
downloadwtf8-4637f6697e2c308be6dc41cda60074106a0f4929.tar.gz
wtf8-4637f6697e2c308be6dc41cda60074106a0f4929.zip
Shorten README filename extension
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8773065
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+wtf8
+====
+
+Tiny utility for interactive use to inspect the octets of UTF-8 strings in line
+with the characters. Expects a single argument, a string.
+
+ $ LANG=C.UTF-8
+ $ export LANG
+ $ make
+ $ sudo make install
+ $ wtf8 'test'
+ 74 65 73 74
+ t e s t
+ $ wtf8 'tøást'
+ 74 c3-b8 c3-a1 73 74
+ t ø á s t
+ $ wtf8 'か'
+ e3-81-8b
+ か
+ $ wtf8 '💦'
+ f0-9f-92-a6
+ 💦
+
+Dependencies
+------------
+
+None as far as I can tell apart from libc, but I've only tested it on GNU/Linux
+with glibc, and on OpenBSD. Should build with GCC or Clang.
+
+Author
+------
+
+Tom Ryder <tom@sanctum.geek.nz>
+
+License
+-------
+
+MIT (see LICENSE)