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

Commits on Jul 12, 2023

  1. 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.
    
    Change-Id: I18018ba23493f43861544497f23ec59f1e8debe1
    BobbyRBruce committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    38d22aa View commit details
    Browse the repository at this point in the history
  2. misc: Update README.md "gem5 Resources" section

    Change-Id: I90296c69098e9bf5987c142d52ab57d556a22009
    BobbyRBruce committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    fb631bd View commit details
    Browse the repository at this point in the history
  3. misc: Update "Getting Help" section

    This section now included expanded information on Reporting bugs and
    Requesting Features.
    
    Change-Id: I555f9f5edb683a1ee235058045fbce07ea473138
    BobbyRBruce committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    0aff716 View commit details
    Browse the repository at this point in the history
  4. misc: Add blurb to README.md intro

    Change-Id: Ic9174d6c3d905f85e2f7f159478d8c93ef7e4079
    BobbyRBruce committed Jul 12, 2023
    Configuration menu
    Copy the full SHA
    2de996a View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2023

  1. scons: Update infopy.py to handle '.' in filename

    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
    BobbyRBruce committed Jul 13, 2023
    Configuration menu
    Copy the full SHA
    bc54504 View commit details
    Browse the repository at this point in the history

Commits on Jul 14, 2023

  1. misc: Expand 'src' desc in README.md

    Co-authored-by: Jason Lowe-Power <jason@lowepower.com>
    BobbyRBruce and powerjg committed Jul 14, 2023
    Configuration menu
    Copy the full SHA
    94d3507 View commit details
    Browse the repository at this point in the history
  2. misc: Update 'Building gem5' to default to ALL comp

    Change-Id: I23f204507be0908afa982712adc9ff7b6c7e8dd3
    Addresss: gem5#71 (comment)
    BobbyRBruce committed Jul 14, 2023
    Configuration menu
    Copy the full SHA
    aa26cc0 View commit details
    Browse the repository at this point in the history
  3. misc: Reorder "Getting Help" list

    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)
    BobbyRBruce committed Jul 14, 2023
    Configuration menu
    Copy the full SHA
    8693edf View commit details
    Browse the repository at this point in the history
  4. scons: Add comment explaining "." -> "_" replace

    Change-Id: Ibfb4642768cc29a5da04ae416ff137ad8bf11b68
    Addresses: gem5#71 (comment)
    BobbyRBruce committed Jul 14, 2023
    Configuration menu
    Copy the full SHA
    7ad4b87 View commit details
    Browse the repository at this point in the history