Skip to content

Commit eac6941

Browse files
committed
Updated README and ran lint fixes
1 parent ae6e8ac commit eac6941

File tree

9 files changed

+26
-26
lines changed

9 files changed

+26
-26
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Although if want to pass flags to the run mode you'll need to specify it.
157157

158158
## Hand Controllers
159159

160-
Stick, paddle and keyboard inputs are supported. Currently, only sitck and
160+
Stick, paddle and keyboard inputs are supported. Currently, only stick and
161161
paddles for the left player are available but keyboard input is available for
162162
both players.
163163

@@ -250,7 +250,8 @@ In playmode, the additional keys are available:
250250
In the debugger, the additional keys are available:
251251

252252
* `ESC` toggle mouse capture for debugging TV screen
253-
* ` (backtick) start/stop emulation
253+
254+
The `Pause` key will toggle pausing in both playmode and in the debugger
254255

255256
### Screenshots
256257

debugger/debugger.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -264,27 +264,27 @@ func NewDebugger(tv *television.Television, scr gui.GUI, term terminal.Terminal,
264264
return dbg, nil
265265
}
266266

267-
// VCS implementes the emulation.Emulation interface.
267+
// VCS implements the emulation.Emulation interface.
268268
func (dbg *Debugger) VCS() emulation.VCS {
269269
return dbg.vcs
270270
}
271271

272-
// Debugger implementes the emulation.Emulation interface.
272+
// Debugger implements the emulation.Emulation interface.
273273
func (dbg *Debugger) Debugger() emulation.Debugger {
274274
return dbg
275275
}
276276

277-
// UserInput implementes the emulation.Emulation interface.
277+
// UserInput implements the emulation.Emulation interface.
278278
func (dbg *Debugger) UserInput() chan userinput.Event {
279279
return dbg.events.UserInput
280280
}
281281

282-
// State implementes the emulation.Emulation interface.
282+
// State implements the emulation.Emulation interface.
283283
func (dbg *Debugger) State() emulation.State {
284284
return dbg.state
285285
}
286286

287-
// Pause implementes the emulation.Emulation interface.
287+
// Pause implements the emulation.Emulation interface.
288288
func (dbg *Debugger) Pause(set bool) {
289289
if set {
290290
dbg.state = emulation.Paused

gui/requests.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type PlusROMFirstInstallation struct {
3939
// Note that, like the name suggests, these are requests, they may or may not
4040
// be satisfied depending other conditions in the GUI.
4141
const (
42-
// set the underlying emulation for the gui
42+
// set the underlying emulation for the gui.
4343
ReqSetEmulation FeatureReq = "ReqSetEmulation" // emulation.Emulation
4444

4545
// notify GUI of emulation state. the GUI should use this to alter how

gui/sdlimgui/lazyvalues/lazy.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ func NewLazyValues() *LazyValues {
9696
}
9797

9898
// SetEmulationState makes sure the lazy system can respond to an emulation in
99-
// a parituclar state.
99+
// a particular state.
100100
func (val *LazyValues) SetEmulationState(state emulation.State) {
101101
switch state {
102102
case emulation.Initialising:

hardware/memory/cartridge/harmony/arm7tdmi/arm7.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ type ARM struct {
145145

146146
// rather than call the cycle counting functions directly, we assign the
147147
// functions to these fields. in this way, we can use stubs when executing
148-
// in immediate mode (when cycle counting isn't necesary)
148+
// in immediate mode (when cycle counting isn't necessary)
149149
//
150150
// other aspects of cycle counting are not expensive and can remain
151151
Icycle func()
@@ -158,11 +158,11 @@ type disasmLevel int
158158
const (
159159
disasmNone disasmLevel = iota
160160

161-
// update entry only if the UpdateExecution is true
161+
// update entry only if the UpdateExecution is true.
162162
disasmUpdateOnly
163163

164164
// update all disassembly fields (operator, operands, etc.). this doesn't
165-
// need to happen unless the entry is not in the disasm cache
165+
// need to happen unless the entry is not in the disasm cache.
166166
disasmFull
167167
)
168168

@@ -674,7 +674,7 @@ func (arm *ARM) Run(mamcr uint32) (uint32, float32, error) {
674674
arm.Scycle(prefetch, arm.registers[rPC])
675675
}
676676

677-
// default to an S cycle for prefetch unless an instruction explicitely
677+
// default to an S cycle for prefetch unless an instruction explicitly
678678
// says otherwise
679679
arm.prefetchCycle = S
680680

@@ -2193,7 +2193,6 @@ func (arm *ARM) executeConditionalBranch(opcode uint16) {
21932193
}
21942194
case disasmNone:
21952195
}
2196-
21972196
}
21982197

21992198
func (arm *ARM) executeSoftwareInterrupt(opcode uint16) {

hardware/memory/cartridge/harmony/arm7tdmi/cycles.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ const (
5656
BranchTrailFlushed
5757
)
5858

59-
// the bus activity during a cycle
59+
// the bus activity during a cycle.
6060
type busAccess int
6161

6262
const (
@@ -72,7 +72,7 @@ func (bt busAccess) isDataAccess() bool {
7272
return bt == dataRead || bt == dataWrite
7373
}
7474

75-
// the type of cycle being executed
75+
// the type of cycle being executed.
7676
type cycleType rune
7777

7878
const (
@@ -248,14 +248,14 @@ func (arm *ARM) nCycle(bus busAccess, addr uint32) {
248248
}
249249
}
250250

251-
// called whenever PC changes unexpectedly (by a branch instruction for example)
251+
// called whenever PC changes unexpectedly (by a branch instruction for example).
252252
func (arm *ARM) fillPipeline() {
253253
arm.Ncycle(branch, arm.registers[rPC])
254254
arm.Scycle(prefetch, arm.registers[rPC]+2)
255255
}
256256

257257
// the cycle profile for store register type instructions is funky enough to
258-
// need a specialist function
258+
// need a specialist function.
259259
func (arm *ARM) storeRegisterCycles(addr uint32) {
260260
arm.Ncycle(dataWrite, addr)
261261
arm.prefetchCycle = N

hardware/memory/cartridge/harmony/arm7tdmi/disasm.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ type DisasmEntry struct {
4040
CyclesSequence string
4141
}
4242

43-
// Key implements the CartCoProcDisasmEntry interface
43+
// Key implements the CartCoProcDisasmEntry interface.
4444
func (e DisasmEntry) Key() string {
4545
return e.Address
4646
}
@@ -71,7 +71,7 @@ func (s DisasmSummary) String() string {
7171
return fmt.Sprintf("N: %d I: %d S: %d", s.N, s.I, s.S)
7272
}
7373

74-
// add cycle order information to summary
74+
// add cycle order information to summary.
7575
func (s *DisasmSummary) add(c cycleOrder) {
7676
for i := 0; i < c.idx; i++ {
7777
switch c.queue[i] {

hardware/tia/video/player.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ func (ps *PlayerSprite) resetPosition() {
500500
} else if ps.tia.hmove.Latch {
501501
// HMOVE has been activated this scanline but not currently rippling.
502502
//
503-
// maybe surprisingly, this is comparitively unusual. many ROMs if
503+
// maybe surprisingly, this is comparatively unusual. many ROMs if
504504
// the reset the player during the HBLANK at all will have called
505505
// HMOVE straight after the WSYNC, as advised by the Stella
506506
// Programmer's Guide.

playmode/play.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,27 +53,27 @@ type playmode struct {
5353
rawEvents chan func()
5454
}
5555

56-
// VCS implementes the emulation.Emulation interface.
56+
// VCS implements the emulation.Emulation interface.
5757
func (pl *playmode) VCS() emulation.VCS {
5858
return pl.vcs
5959
}
6060

61-
// Debugger implementes the emulation.Emulation interface.
61+
// Debugger implements the emulation.Emulation interface.
6262
func (pl *playmode) Debugger() emulation.Debugger {
6363
return nil
6464
}
6565

66-
// UserInput implementes the emulation.Emulation interface.
66+
// UserInput implements the emulation.Emulation interface.
6767
func (pl *playmode) UserInput() chan userinput.Event {
6868
return pl.userinput
6969
}
7070

71-
// State implementes the emulation.Emulation interface.
71+
// State implements the emulation.Emulation interface.
7272
func (pl *playmode) State() emulation.State {
7373
return pl.state
7474
}
7575

76-
// Pause implementes the emulation.Emulation interface.
76+
// Pause implements the emulation.Emulation interface.
7777
func (pl *playmode) Pause(set bool) {
7878
if set {
7979
pl.state = emulation.Paused

0 commit comments

Comments
 (0)