Azure-Samples / azure-government-openai-access

Companion sample application for Azure Government OpenAI Access
MIT License
18 stars 2 forks source link

Typos and more detail for README.md #3

Open robcamer opened 1 year ago

robcamer commented 1 year ago

Please provide us with the following information:

This issue is for a: (mark with an x)

- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [ x] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

When going through the README.md, I found a couple of typos and areas where it could use more clarity.

Any log messages given by the failure

The commands are generally for Linux while many of our DOD customers run Windows. Some typos / missing variables and commands.

Expected/desired behavior

The README.md is more clear on steps to take for Windows and Linux.

OS and Version?

Windows 11 and Ubuntu 22.04.

Versions

Mention any other details that might be useful

I have made several edits to the README.md and plan to submit a pull request.


Thanks! We'll be in touch soon.