Skip to content

Commit 43791c4

Browse files
committed
Some updates to the README
1 parent 815d146 commit 43791c4

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

README.md

+16-19
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# Chiptracker
22

3-
Chip tracker for the bitbox, based on [lft's HArdware Chiptune](http://www.linusakesson.net/hardware/chiptune.php)
3+
Chip tracker for the bitbox, based on [lft's Hardware Chiptune](http://www.linusakesson.net/hardware/chiptune.php)
44

55
![screenshot](chiptracker.png)
66

7-
## Major changes
7+
## Updated documentation (things that changed from lft's original tracker)
88

9-
Squashed PLAY/EDIT/IDLE modes down into one, because it felt difficult to
10-
move around nimbly.
9+
Start the tracker by loading the binary from the bitbox bootloader, or use the
10+
emulator version.
1111

12-
TODO: Add some extra info in song column, to show Track and Transposition columns.
12+
* Press Ctrl+O to list and load files (from SD card or current directory in emu).
13+
* Press Ctrl+F to change the file name, then Ctrl+W to save.
14+
* Press space to play/pause, enter to toggle edit mode
15+
* In the emulator, press escape to exit. On real hardware, use the reset button.
1316

17+
Don't worry, there are on-screen hints to all this.
1418

15-
## Original Documentation
19+
## Original Documentation (with out of date information removed)
1620

1721
Hi!
1822

19-
This is the tracker I used in the hardware chiptune project
20-
(http://www.linusakesson.net/hardware/chiptune.php). It was never intended to
23+
This is the tracker I used in the
24+
[hardware chiptune project](http://www.linusakesson.net/hardware/chiptune.php).
25+
It was never intended to
2126
be used by anyone other than me, so it's not exactly user friendly.
2227

2328
This is a quick documentation attempt.
2429

25-
You have to give the tracker a file name when you're starting it. So type
26-
"./tracker test2.song" to start working on the existing song, or type e.g.
27-
"./tracker my_song.song" to start from scratch. Although the GUI hints that you
28-
can later press ^F to change the file name, this was never implemented.
29-
3030
Once you've started the tracker, you'll see that the screen is divided into
3131
three sections: song, track and instrument. Use TAB to move between these
3232
sections. Alternatively, if you're in the song section and the cursor is on a
@@ -41,10 +41,8 @@ Use < and > to change the current octave. The main part of the keyboard is used
4141
to enter notes. The keyboard layout is adapted for a US qwerty keymap. You can
4242
edit gui.c to change this to fit a Dvorak keymap instead.
4343

44-
Press ^E (control-E) to exit without saving. Press ^W ("write") to save. Press
45-
\# to optimize the song (remove unused tracks, move tracks together) and % to
46-
export the song into a packed format. (% will always export to two files called
47-
"exported.s" and "exported.h" in the current working directory).
44+
Press ^W ("write") to save. Press
45+
\# to optimize the song (remove unused tracks, move tracks together).
4846

4947
In the song and instrument editors, use capital A, I and D to add, insert and
5048
delete lines. In the track and instrument editors, use capital C and V for copy
@@ -70,8 +68,7 @@ The available commands are:
7068
~xy Set vibrato. x = depth, y = rate.
7169

7270
Investigate test2.song, and play around, and you'll probably get the hang of
73-
things! Remember that the packed format only supports one command per track
74-
line (see homepage).
71+
things!
7572

7673
Good luck!
7774

0 commit comments

Comments
 (0)