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 file of quantum Chinese chess #204

Merged
merged 14 commits into from
Jul 31, 2024
Merged

Conversation

madcpf
Copy link
Collaborator

@madcpf madcpf commented Jul 22, 2024

Update readme file of quantum Chinese chess to include game rules and commands.

@madcpf madcpf marked this pull request as draft July 22, 2024 06:03
@madcpf madcpf marked this pull request as ready for review July 31, 2024 19:30
@madcpf madcpf requested a review from dstrain115 July 31, 2024 21:24
Copy link
Collaborator

@dstrain115 dstrain115 left a comment

Choose a reason for hiding this comment

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

Cool! Love the documentation!

examples/quantum_chinese_chess/README.md Outdated Show resolved Hide resolved
After cloning the Unitary library you can use command line flags to run the game:
## How to run the game

After cloning the Unitary library you can use the following command line to run the game:
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: comma after library.


```
python -m examples.quantum_chinese_chess.chess
```

Currently we don't have a graphical interface. Text display is supported at Linux terminal, Mac terminal, Colab, and Sublime Terminus.
Copy link
Collaborator

Choose a reason for hiding this comment

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

comma after Currently

@madcpf
Copy link
Collaborator Author

madcpf commented Jul 31, 2024

Cool! Love the documentation!

Thanks a lot for the review!

@madcpf madcpf merged commit 616ac6d into quantumlib:main Jul 31, 2024
6 checks passed
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