Add documentation, rename package.

Other changes:

* Make sure to count foul tip as a swing and miss.
* Add ability to display box score in editor

README.md

@@ -1,4 +1,19 @@
 # paperscore
 
-*paperscore* is a paper based softball (and baseball) scoring system for amateur games.  The paper score can be re-entered into a computer readable format from which this software can generate box scores and a variety of statistics.
+*paperscore* is a hybrid paper-computer softball scoring system that I've been using for the last couple of years to score amateur travel softball games.
+
+Some features and notes:
+
+* The software computes a variety of batting statistics that it can export in CSV format.  The CSV files can be imported into any of a number of other systems for additional analysis.  Personally I've been using [hex.tech](https://hex.tech).
+* The scoring notation and software support entering "alternate plays", which is a play which in the scorers opinion should have occurred.  The software can compute the expected run cost of these errors and misplays.
+* The scoring notation is derived from [retrosheet](https://www.retrosheet.org).
+* The software is incomplete, and undoubtedly has bugs.  Some of the code is experimental was just "left in" possibly to be completely later or more likely not at all.
+* The error messages leave a lot to be desired.  I've found myself running the code in the debugger just to figure out what the actual error was.
+* There's a text UI editor for games that I find helpful.
+
+## Sample Paper Score
+
+Here's a sample score sheet:
+
+![Sample Score](/doc/score.jpeg)
 

cmd/alt.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 )
 

cmd/batcount.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 )
 

cmd/batting_times.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 )
 

cmd/box.go

@@ -8,9 +8,9 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/slshen/sb/pkg/boxscore"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/boxscore"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v3"
 )

cmd/dataexport.go

@@ -3,9 +3,9 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/dataexport"
-	"github.com/slshen/sb/pkg/dataframe/pkg"
-	"github.com/slshen/sb/pkg/game"
+	"github.com/slshen/paperscore/pkg/dataexport"
+	"github.com/slshen/paperscore/pkg/dataframe/pkg"
+	"github.com/slshen/paperscore/pkg/game"
 	"github.com/spf13/cobra"
 )
 

cmd/fmt.go

@@ -1,7 +1,7 @@
 package cmd
 
 import (
-	"github.com/slshen/sb/pkg/game"
+	"github.com/slshen/paperscore/pkg/game"
 	"github.com/spf13/cobra"
 )
 

cmd/newgame.go

@@ -1,7 +1,7 @@
 package cmd
 
 import (
-	"github.com/slshen/sb/pkg/gamefile"
+	"github.com/slshen/paperscore/pkg/gamefile"
 	"github.com/spf13/cobra"
 )
 

cmd/pitching_times.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 )
 

cmd/playbyplay.go

@@ -4,8 +4,8 @@ import (
 	"log"
 	"os"
 
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/playbyplay"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/playbyplay"
 	"github.com/spf13/cobra"
 )
 

cmd/re.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 )
 

cmd/re_args.go

@@ -1,9 +1,9 @@
 package cmd
 
 import (
-	"github.com/slshen/sb/pkg/config"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/config"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/pflag"
 )
 

cmd/read.go

@@ -3,7 +3,7 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/game"
+	"github.com/slshen/paperscore/pkg/game"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v3"
 )

cmd/sim.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/markov"
-	"github.com/slshen/sb/pkg/markov/expr"
+	"github.com/slshen/paperscore/pkg/markov"
+	"github.com/slshen/paperscore/pkg/markov/expr"
 	"github.com/spf13/cobra"
 )
 

cmd/stats.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 	"github.com/spf13/cobra"
 )
 

cmd/tournament.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/tournament"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/tournament"
 	"github.com/spf13/cobra"
 )
 

cmd/ui.go

@@ -4,7 +4,7 @@ import (
 	"log"
 	"os"
 
-	"github.com/slshen/sb/pkg/ui"
+	"github.com/slshen/paperscore/pkg/ui"
 	"github.com/spf13/cobra"
 )
 

go.mod

@@ -1,4 +1,4 @@
-module github.com/slshen/sb
+module github.com/slshen/paperscore
 
 go 1.22.0
 

main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"os"
 
-	"github.com/slshen/sb/cmd"
+	"github.com/slshen/paperscore/cmd"
 )
 
 func main() {

pkg/boxscore/box.go

@@ -7,11 +7,11 @@ import (
 	"strings"
 	"text/template"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/playbyplay"
-	"github.com/slshen/sb/pkg/stats"
-	"github.com/slshen/sb/pkg/text"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/playbyplay"
+	"github.com/slshen/paperscore/pkg/stats"
+	"github.com/slshen/paperscore/pkg/text"
 )
 
 //go:embed "*.tmpl"

pkg/boxscore/box_test.go

@@ -5,7 +5,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/slshen/sb/pkg/game"
+	"github.com/slshen/paperscore/pkg/game"
 	"github.com/stretchr/testify/assert"
 )
 

pkg/boxscore/lineup.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/stats"
-	"github.com/slshen/sb/pkg/text"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/stats"
+	"github.com/slshen/paperscore/pkg/text"
 )
 
 type Lineup struct {

pkg/boxscore/util.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 	"text/template"
 
-	"github.com/slshen/sb/pkg/text"
+	"github.com/slshen/paperscore/pkg/text"
 )
 
 func firstWord(s string, w int) string {

pkg/dataexport/dataexport.go

@@ -5,11 +5,11 @@ import (
 	"sort"
 	"time"
 
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/dataframe/pkg"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
-	"github.com/slshen/sb/pkg/tournament"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/dataframe/pkg"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
+	"github.com/slshen/paperscore/pkg/tournament"
 )
 
 type DataExport struct {

pkg/dataexport/event.go

@@ -7,9 +7,9 @@ import (
 	"strings"
 
 	"github.com/mitchellh/mapstructure"
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 )
 
 type Event struct {

pkg/dataexport/event_test.go

@@ -3,7 +3,7 @@ package dataexport
 import (
 	"testing"
 
-	"github.com/slshen/sb/pkg/game"
+	"github.com/slshen/paperscore/pkg/game"
 	"github.com/stretchr/testify/assert"
 )
 

pkg/dataexport/game.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"path/filepath"
 
-	"github.com/slshen/sb/pkg/boxscore"
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
+	"github.com/slshen/paperscore/pkg/boxscore"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
 )
 
 type Game struct {

pkg/dataexport/gamestats.go

@@ -1,9 +1,9 @@
 package dataexport
 
 import (
-	"github.com/slshen/sb/pkg/dataframe"
-	"github.com/slshen/sb/pkg/game"
-	"github.com/slshen/sb/pkg/stats"
+	"github.com/slshen/paperscore/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/game"
+	"github.com/slshen/paperscore/pkg/stats"
 )
 
 type GameStats struct {

pkg/dataexport/tournament.go

@@ -3,7 +3,7 @@ package dataexport
 import (
 	"time"
 
-	"github.com/slshen/sb/pkg/tournament"
+	"github.com/slshen/paperscore/pkg/tournament"
 )
 
 type Tournament struct {

pkg/dataframe/data.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 
 	"github.com/mitchellh/mapstructure"
-	"github.com/slshen/sb/pkg/text"
+	"github.com/slshen/paperscore/pkg/text"
 )
 
 type Update interface {

pkg/dataframe/pkg/datapackage.go

@@ -8,7 +8,7 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/slshen/sb/pkg/dataframe"
+	"github.com/slshen/paperscore/pkg/dataframe"
 )
 
 type License string

pkg/game/advance.go

@@ -3,7 +3,7 @@ package game
 import (
 	"regexp"
 
-	"github.com/slshen/sb/pkg/gamefile"
+	"github.com/slshen/paperscore/pkg/gamefile"
 )
 
 type Advance struct {

pkg/game/advance_test.go

@@ -3,7 +3,7 @@ package game
 import (
 	"testing"
 
-	"github.com/slshen/sb/pkg/gamefile"
+	"github.com/slshen/paperscore/pkg/gamefile"
 	"github.com/stretchr/testify/assert"
 )
 

pkg/game/error.go

@@ -3,7 +3,7 @@ package game
 import (
 	"fmt"
 
-	"github.com/slshen/sb/pkg/gamefile"
+	"github.com/slshen/paperscore/pkg/gamefile"
 )
 
 type Error struct {

pkg/game/fieldingerror.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/slshen/sb/pkg/gamefile"
+	"github.com/slshen/paperscore/pkg/gamefile"
 )
 
 type FieldingError struct {