resources: Updated README to describe versioning and usage info
Information on how the gem5-resources repository is to be versioned, and
how the repository is to be used, has been added to the README.
diff --git a/README.md b/README.md
index 4b74168..d73e3aa 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
# gem5 Resources
This repository contains the sources needed to compile the gem5 resources.
-Outlined in the following sections are build instructions for each of our
-gem5 resources.
+The compiled resources are found in the gem5 resources bucket,
+http://dist.gem5.org/dist. Though these resources are not needed to compile or
+run gem5, they may be required to execute some gem5 tests or may be useful
+when carrying out specific simulations.
+
+The structure of this repository is as follows:
* **Makefile** : Used to compile the resources. Please consult the sections
below for dependencies that may be required to compile these resources.
@@ -12,6 +16,56 @@
`output/test-progs/riscv-tests/median.riscv` can be found at
http://dist.gem5.org/dist/current/test-progs/riscv-tests/median.riscv.
+The following sections outline our versioning policy, how to make changes
+to this repository, and describe each resource and how they may be built.
+
+# Versioning
+
+We ensure that for each version of
+the [gem5 source](https://gem5.googlesource.com/public/gem5/) there is a
+corresponding version of the gem5-resources, with the assumption that version X
+of the gem5 source will be used with version X of the gem5-resources. The
+gem5-resources repository contains two branches, develop and master. The master
+branch's HEAD points towards the latest gem5 resources release, which will be
+the same version id as the that of the latest gem5 source. E.g., if the latest
+release of gem5 is v20.2.0.0, then the latest release of gem5-resources
+will be v20.2.0.0, with the HEAD of its master branch tagged as v20.2.0.0.
+Previous versions will be tagged within the master branch. Past versions
+gem5-resources can thereby be checked out with `git checkout <VERSION>`. A
+complete list of versions can be found with `git tag`. The develop branch
+constains code under development and will be merged into the master branch,
+then tagged, as part of the next release of gem5.
+
+The compiled resources for gem5 can be found under
+http://dist.gem5.org/dist/{VERSION}. E.g. compiled resources for gem5 v20.2.0.0
+are under http://dist.gem5.org/dist/v20-2-0-2 and are compiled from
+gem5-resources v20.2.0.0. http://dist.gem5.org/dist/current is kept in sync
+with the develop branch, and therefore should not be depended upon for stable,
+regular usage.
+
+# Making Changes
+
+Changes to this repository are made to the develop branch via our Gerrit
+code review system. Therefore, to make changes, first clone the repository
+checkout the develop branch:
+
+```
+git clone https://gem5.googlesource.com/public/gem5-resources
+git checkout --track origin/develop
+```
+
+Then make changes and commit. When ready, push to Gerrit with:
+
+```
+git push origin HEAD:refs/for/develop
+```
+
+The change will then be reviewed via our [Gerrit code review system](
+https://gem5-review.googlesource.com). Once fully accepted and merged into
+the gem5-resources repository, please contact Bobby R. Bruce
+[mailto:bbruce@ucdavis.edu](bbruce@ucdavis.edu) to have the compiled sources
+uploaded to the gem5 resources bucket.
+
# Resource: RISCV Tests
Origin: <https://github.com/riscv/riscv-tests.git>
@@ -51,6 +105,7 @@
```
make riscv-tests
```
+
The output of this compilation can be found at
`dist/current/test-progs/riscv-tests/`
