From fee7e552d312a42ba7c2351290ba4cdad1028d4e Mon Sep 17 00:00:00 2001
From: Robert Gerus <ar@is-a.cat>
Date: Tue, 15 Aug 2023 18:01:06 +0200
Subject: [PATCH] docs: nick now supports pronouns

reformatted the section because lines were getting too long
---
 docs/badge/usage.rst | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/docs/badge/usage.rst b/docs/badge/usage.rst
index 74a00e1798..8d660424a1 100644
--- a/docs/badge/usage.rst
+++ b/docs/badge/usage.rst
@@ -41,17 +41,20 @@ You can plug in a pair of headphones to the 3.5mm jack on the bottom-left petal.
 The built-in speakers will then turn off and audio will go out through the
 headphones. You can adjust their volume in the same way.
 
-Showing your nick
------------------
+Showing your nick and pronouns
+------------------------------
 
-You can navigate to Badge |rarr| Nick to display your nick. If your nick is
-``flow3r``, congratulations! You're ready to go. Otherwise, you'll have to
-connect your badge to a computer and edit a file to change your nick.
+You can navigate to Badge |rarr| Nick to display your nick and pronouns. If
+your nick is ``flow3r``, and you have no pronouns, congratulations! You're
+ready to go. Otherwise, you'll have to connect your badge to a computer and
+edit a file to change your nick and pronouns.
 
-From the main menu, navigate to System |rarr| Disk Mode (Flash). Connect your badge
-to a computer, and it will appear as a mass storage device (a.k.a. pendrive).
-Open the file ```nick.json`` in a text editor and change your nick, the size of
-the font, and whatever else you wish.
+From the main menu, navigate to System |rarr| Disk Mode (Flash). Connect your
+badge to a computer, and it will appear as a mass storage device (a.k.a.
+pendrive). Open the file ```nick.json`` in a text editor and change your nick,
+pronouns, font sizes for nick and pronouns, and whatever else you wish. Please
+note that ``pronouns`` is a list, and should be formatted as such. for example:
+``"pronouns": ["aa/bb", "cc/dd"],``
 
 For the ``nick.json`` file to appear, you must have started the Nick app at
 least once.
@@ -97,4 +100,4 @@ Toy synthesizer. Bottom three petals select octave, Top 7 petals play a note fro
 Harmonic
 ^^^^^^^^
 
-Toy synthesizer. White petals select chord, pink petals play note.
\ No newline at end of file
+Toy synthesizer. White petals select chord, pink petals play note.
-- 
GitLab