Skip to content

Commit

Permalink
docs: Simplify README by removing package details
Browse files Browse the repository at this point in the history
Streamline the project documentation by removing the detailed package
descriptions from the README. This change focuses the documentation on
essential information for users, such as installation and usage
instructions, making it more concise and easier to navigate.
  • Loading branch information
pblittle committed Sep 10, 2024
1 parent fd64dd2 commit b6af05a
Showing 1 changed file with 1 addition and 49 deletions.
50 changes: 1 addition & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,54 +19,6 @@ Currently, Albatross supports the [MLM2Pro](https://rapsodo.com/pages/mlm2pro-go

Albatross currently outputs processed data in the [Shot Pattern](https://shotpattern.app/) format. This is the default and only output format available.

## Packages

### Models (`internal/models`)

Defines core data structures and interfaces:

- `LaunchMonitor` interface for different launch monitor types
- `RawShotData` struct for storing raw shot data
- `ProcessedShotData` struct for storing processed shot information

### Reader (`internal/reader`)

Provides implementations for different types of launch monitors:

- `MLM2ProLaunchMonitor` for processing data from MLM2Pro launch monitors

### Parsers (`internal/parsers`)

Contains functions for reading and parsing shot data:

- `ProcessShotData` function for reading and processing CSV files

### Processors (`internal/processors`)

Provides functionality for processing golf-related data:

- `NormalizeClubType` function for standardizing club type notation
- `DetermineShotType` function for categorizing shots as Tee or Approach

### Calculators (`internal/calculators`)

Performs statistical analysis of golf shot data:

- `CalculateTargets` function for computing median target distances for each club type

### Utils (`utils`)

Offers utility functions for common tasks:

- `ReplaceFileExtension` function for manipulating file names
- `WriteCSV` function for exporting processed data to CSV files

### Writer (`internal/writer`)

Handles writing processed data to output files:

- `ShotPatternWriter` for writing processed shot data to CSV

## Installation

To install this project, make sure you have Go installed on your system, then clone the repository:
Expand All @@ -81,7 +33,7 @@ cd albatross
Albatross is a command-line application. Here's how to use it:

```shell
go run main.go <launch_monitor_type> <input_csv_file>
go run main.go &lt;launch_monitor_type&gt; &lt;input_csv_file&gt;
```

For example:
Expand Down

0 comments on commit b6af05a

Please sign in to comment.