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

misc: Update README/README.md #71

Merged
merged 9 commits into from Jul 17, 2023
Merged

Conversation

BobbyRBruce
Copy link
Member

Change-Id: Ic9174d6c3d905f85e2f7f159478d8c93ef7e4079

This change converts the text-based README to markdown. This works
better with modern source-control systems, most notably, GitHub.

The README.md has been broken down into sections to better organize the
document.

Change-Id: I18018ba23493f43861544497f23ec59f1e8debe1
Change-Id: I90296c69098e9bf5987c142d52ab57d556a22009
This section now included expanded information on Reporting bugs and
Requesting Features.

Change-Id: I555f9f5edb683a1ee235058045fbce07ea473138
Change-Id: Ic9174d6c3d905f85e2f7f159478d8c93ef7e4079
Due to renaming 'README' to 'README.md', this code was generating the
following for "info.py":

```
README.md = "<FILE CONTENTS HERE>"
```

As '.' is used to access member variables/methods in python. To fix this
"infopy.oy" now replaces "." with "_". As such the generated in in
"info.py" is now:

```
README_MD = "<FILE CONTENTS HERE>"

Change-Id: I834fa84f654b27ef399a31cda545d2bf2d906390
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
build_tools/infopy.py Show resolved Hide resolved
src/SConscript Show resolved Hide resolved
Co-authored-by: Jason Lowe-Power <jason@lowepower.com>
Change-Id: I23f204507be0908afa982712adc9ff7b6c7e8dd3
Addresss: gem5#71 (comment)
@gem5 gem5 deleted a comment from powerjg Jul 14, 2023
This puts GitHub Discussions and GitHub Issues towards the top of the
list. This is to incentivize their usage.

Change-Id: I248e3a5ace58bf909182300a3c44a412a8d73e6e
Addresses: gem5#71 (comment)
Change-Id: Ibfb4642768cc29a5da04ae416ff137ad8bf11b68
Addresses: gem5#71 (comment)
@BobbyRBruce
Copy link
Member Author

BTW: I didn't mean to delete that comment. It was you asking to make ALL/gem5.opt the default. I did so.

@powerjg powerjg merged commit f80015e into gem5:develop Jul 17, 2023
5 checks passed
BobbyRBruce added a commit to BobbyRBruce/gem5 that referenced this pull request Jul 19, 2023
* misc: Update README to README.md

This change converts the text-based README to markdown. This works
better with modern source-control systems, most notably, GitHub.

The README.md has been broken down into sections to better organize the
document.
This section now included expanded information on Reporting bugs and
Requesting Features.

Due to renaming 'README' to 'README.md', this code was generating the
following for "info.py":

```
README.md = "<FILE CONTENTS HERE>"
```

As '.' is used to access member variables/methods in python. To fix this
"infopy.oy" now replaces "." with "_". As such the generated in in
"info.py" is now:

```
README_MD = "<FILE CONTENTS HERE>"

This puts GitHub Discussions and GitHub Issues towards the top of the
list. This is to incentivize their usage.

Change-Id: I18018ba23493f43861544497f23ec59f1e8debe1

---------

Co-authored-by: Jason Lowe-Power <jason@lowepower.com>
@BobbyRBruce BobbyRBruce deleted the update-readme branch December 14, 2023 07:21
cyyself pushed a commit to cyyself/gem5 that referenced this pull request Apr 30, 2024
misc: Fix SE mode. But we don't suggest to use it
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.

None yet

2 participants