Skip to content

Commit

Permalink
doc: README.md (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasDevApps authored Sep 26, 2024
1 parent baedc50 commit 23f43ff
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,13 @@ draw a grid taking into account probabilities, etc...
Please note that this type of program in no way guarantees that you will
have better lottery luck.

## Features
## 🔎 Preview

- See how many times numbers have been drawn
- Draw a grid at random while taking into account the probability of
each number being drawn.
- Find out if the grid drawn at random is a winning grid
- Access to csv statistics: number of grids present, date of last and first grid drawn.

## Preview
*The design is customisable.*

![Alt text](./example/assets/preview.png?raw=true "Title")

The design is customisable.

## Getting started
## 🚀 Getting started

At the top of the application, you need to initialise the lottery with a
CSV file to be used as data :
Expand All @@ -58,10 +50,18 @@ Future<void> main() async {

The `pathCsv` can be for example `C:\\Users\\username\\Desktop\\Data\\MyLottery\\data.csv`.

## Usage
## 🪄 Features

- See how many times numbers have been drawn
- Draw a grid at random while taking into account the probability of
each number being drawn.
- Find out if the grid drawn at random is a winning grid
- Access to csv statistics: number of grids present, date of last and first grid drawn.

## 📖 Usage

A complete example is in the `example` folder.

## Additional information
## Additional information

This package is not officially linked to any lottery.
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: lottery
description: "A new Flutter project."
version: 0.0.19
version: 0.0.20

environment:
sdk: '>=3.3.3 <4.0.0'
Expand Down

0 comments on commit 23f43ff

Please sign in to comment.