Documentation Updates

README.md

@@ -0,0 +1,31 @@
+# sBitx 
+
+This is the Github source repository for the HFSignals sBitx models.
+
+https://www.hfsignals.com/index.php/sbitx-v2/
+
+The sBitx is an open source, high performance Hybrid SDR for the 21st 
+century radio amateurs. Powered by an internal Raspberry Pi 4, it has 
+CW/RTTY/PSK31/SSB and FT8 with logging software, macros, spotting built-in.
+
+!["sBitx v2"](https://www.hfsignals.com/wp-content/uploads/2023/04/sbitxv2hero3.jpg)
+
+
+## Important documentation
+
+* Getting Started (Hello v2) [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/hellov2.md)] [[PDF](https://github.com/afarhan/sbitx/blob/main/doc/pdf/hellov2.pdf)]
+* Install [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/install.md)]
+* Commands [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/commands.md)]
+* How the GUI is organized [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/how_gui_is_organized.md)]
+* UI Notes [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/ui_notes.md)]
+* WSJT-X Notes [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/wsjtx_notes.md)]
+* Coding Convention [[Markdown](https://github.com/afarhan/sbitx/blob/main/doc/coding_convention.md)]
+
+## Hardware Schematics
+* sBitx Digital [[PDF](https://github.com/afarhan/sbitx/blob/main/doc/pdf/sbitx_digital.pdf)]
+* sBitx Main [[PDF](https://github.com/afarhan/sbitx/blob/main/doc/pdf/sbitx_main.pdf)]
+* sBitx v2 Circuit [[PDF](https://github.com/afarhan/sbitx/blob/main/doc/pdf/sbitxv2_circuit.pdf)]
+
+## Community mailing list
+https://groups.io/g/bitx20
+

coding_convention.txt → doc/coding_convention.md

@@ -1,6 +1,8 @@
+# Coding Convention
+
 This is a short note on the coding conventions followed with the source code of sbitx.
 
-1. The source code files should be formatted so that they don't go paste the right edge of the 
+1. The source code files should be formatted so that they don't go past the right edge of the 
 screen on the 800x480 display of the Raspberry Pi.
 
 2. For function and variable names, we use all small case with underscore (_) to seperate out 

commands.txt → doc/commands.md

@@ -1,40 +1,46 @@
-These are text commands that can be entered from the keyboard
-\callsign [callsign]
+# Commands
+
+These are text commands that can be entered from the keyboard:
+- `\callsign [callsign]`
 	Sets your callsign to the following string.
-\grid [grid]
+
+- `\grid [grid]`
 	Sets your grid (six letters) that is used in FT8 and other modes to 
 	indicate your approximate locationi.
-\freq [frequency in Hz or Kilohertz]
+
+- `\freq [frequency in Hz or Kilohertz]`
 	You can also type just 'f' instead 'freq' 
 	if you the type '\f 7050' it will set be the same as '\freq 7050000'
-\cwdelay [100-2000] msec. How long radio remains in transmit in CW before
-	timing out to rx. ex: "\cwdelay 500"
-\cwinput [key\keyer\kbd]
+
+- `\cwdelay [100-2000]`
+    How long radio remains in transmit in CW before timing out to rx in ms. ex: "\cwdelay 500"
+
+- `\cwinput [key\keyer\kbd]`
 	Chooses the CW input method between straight key(key), Iambic keyer(keyer)
 	and the keyboard (kbd).
-\mode [USB\LSB\etc..]...
+
+- `\mode [USB\LSB\etc..]`
 	Chooses from the modes available in the mode selection control.
 	You can use 'm' instead of 'mode'
-\t 
+
+- `\t` 
 	Puts the radio into transmit. You can also use Ctrl-T
-\r 
+
+- `\r` 
 	Puts the radio into receive. You can also use Ctrl-R
-\topen [server]:[port]
+
+- `\topen [server]:[port]`
 	Opens a telnet session with an RBN or a DX cluster telnet server.
 	It works with ip address as well as domain names
 	Ex: \topen dxc.g3lrs.org.ul:7300
-\tclose 
+
+- `\tclose` 
 	Closes the existing telnet session
-\w [telnet command string]
+
+- `\w [telnet command string]`
 	Writes the remaining text (skipping the space after '\w') to the
 	currently opened telnet server
-\txpitch [in Hz]
+
+- `\txpitch [in Hz]`
 	Sets the tone of transmit tone of the CW. 
 	Ex: \txpitch 700
-\
-
-
-
-
-
-