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.

Sign up for GitHub

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

Jump to bottom

Improve examples documentation to make it clear that they are standalone #536

Closed
ChrisCummins opened this issue Jan 10, 2022 · 0 comments · Fixed by #548
Closed

Improve examples documentation to make it clear that they are standalone #536

ChrisCummins opened this issue Jan 10, 2022 · 0 comments · Fixed by #548
Assignees
@ChrisCummins
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request
Milestone
v0.2.3

Comments

@ChrisCummins
Copy link
Contributor

🚀 Feature

Tangentially to #532, I think it would be good to add a "Usage" section to examples/README.md that makes it clear that these example scripts can be used through pip-installed CompilerGym, and possibly split the examples rules out of the top level makefile into an examples/Makefile file for standalone usage.

Motivation

It is not clear whether the included examples require building from source (they don't) or can be used on their own (they can).
@ChrisCummins ChrisCummins added the Enhancement New feature or request label Jan 10, 2022
@ChrisCummins ChrisCummins added this to the v0.2.3 milestone Jan 10, 2022
ChrisCummins added a commit to ChrisCummins/CompilerGym that referenced this issue Jan 19, 2022
@ChrisCummins
[examples] Split Makefile to be standalone and improve readme.
f7c2f63 
Fixes facebookresearch#536.
@ChrisCummins ChrisCummins mentioned this issue Jan 19, 2022
Merged
ChrisCummins added a commit to ChrisCummins/CompilerGym that referenced this issue Jan 27, 2022
@ChrisCummins
[examples] Split Makefile to be standalone and improve readme.
a4ccd23 
Fixes facebookresearch#536.
ChrisCummins added a commit to ChrisCummins/CompilerGym that referenced this issue Feb 7, 2022
@ChrisCummins
[examples] Split Makefile to be standalone and improve readme.
9e3f975 
Fixes facebookresearch#536.
@ChrisCummins ChrisCummins added the Documentation Improvements or additions to documentation label Mar 4, 2022
ChrisCummins added a commit to ChrisCummins/CompilerGym that referenced this issue Mar 6, 2022
@ChrisCummins
[examples] Split Makefile to be standalone and improve readme.
9e8a2ed 
Fixes facebookresearch#536.
ChrisCummins added a commit to ChrisCummins/CompilerGym that referenced this issue Mar 9, 2022
@ChrisCummins
[examples] Split Makefile to be standalone and improve readme.
321d31c 
Fixes facebookresearch#536.
ChrisCummins added a commit to ChrisCummins/CompilerGym that referenced this issue Mar 17, 2022
@ChrisCummins
[examples] Split Makefile to be standalone and improve readme.
6630b7e 
Fixes facebookresearch#536.
@ChrisCummins ChrisCummins self-assigned this Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ChrisCummins ChrisCummins

Labels
Documentation Improvements or additions to documentation Enhancement New feature or request
Projects
None yet
Milestone
v0.2.3
Development

Successfully merging a pull request may close this issue.

[examples] Split Makefile to be standalone and improve readme. ChrisCummins/CompilerGym
1 participant
@ChrisCummins