5 Commits

Author SHA1 Message Date
Simon Lammer
665d32cba2 misc: Fix typo in README.md (#1763) 2024-11-11 10:03:54 -08:00
Ivana Mitrovic
ba0c3cc29a misc: Update GitHub badge links (#1428)
Change-Id: Iaead9f6146a90c9b2a671b9b78a318869ca739e6
2024-08-08 08:44:26 -07:00
Yu-Cheng Chang
2825bc1d55 misc: Add missing RISCV valid ISA option to README.md (#462)
The list of valid ISA options should be same as the website:
https://www.gem5.org/documentation/general_docs/building

Change-Id: Id5ace5b0356ec35634caec5b11159551801c0615
2023-10-16 09:45:28 -07:00
Bobby R. Bruce
fee465c97c misc: Add test status badges to README.md
These allow visitors to the repository to quickly see the status of our
tests run on the develop branch.

Change-Id: I3658c0e0d9dea66feebd69588c8a29d369a0b43d
2023-08-28 23:01:56 -07:00
Bobby R. Bruce
f80015ea18 misc: Update README/README.md (#71)
* 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>
2023-07-17 15:30:35 -07:00