Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #1

wants to merge 1 commit into from

Conversation

linfraze
Copy link

No description provided.

- Calculate your own Pi data file with [y-cruncher](http://www.numberworld.org/y-cruncher/)
- Perform the following steps:

1. Set the location of the file as an environment variable:
Copy link
Owner

@frazieje frazieje Apr 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the update to use an unordered list for the data file options, but this line about setting the location of the file starts the next section, which should be titled "Configuring the data file" or "using your data file" or something like that

```shell
$ ./gradlew run -PpiData=[location of data file]
```

### Usage
To use the HTTP API once running:
After you run the program, use the HTTP API:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"After you run the program, use the HTTP to search for a number in Pi:"

Should we also mention that they need to update the searchText to whatever number they want to search for?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants