Gabe Black has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/50755 )
Change subject: misc: Update gem5's README file.
......................................................................
misc: Update gem5's README file.
Remove references to alpha and SWIG. Change the list of configs to be a
list of configs and not ISAs even though they are frequently named after
the ISA, say that the options are in build_opts, add in missing top
level directories, update and generalize the description of full system,
re-wrap some text.
Change-Id: Id2fb9323dcb9d8bf8e86c78fb5e9aa6afed1c5b8
---
M README
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/README b/README
index e24e7a3..554624e 100644
--- a/README
+++ b/README
@@ -8,29 +8,33 @@
http://www.gem5.org/documentation/learning_gem5/introduction.
To build gem5, you will need the following software: g++ or clang,
-Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
-and lastly protobuf if you want trace capture and playback
-support. Please see http://www.gem5.org/documentation/general_docs/building
-for more details concerning the minimum versions of the aforementioned
tools.
+Python (gem5 links in the Python interpreter), SCons, zlib, m4, and lastly
+protobuf if you want trace capture and playback support. Please see
+http://www.gem5.org/documentation/general_docs/building for more details
+concerning the minimum versions of these tools.
Once you have all dependencies resolved, type 'scons
-build/<ARCH>/gem5.opt' where ARCH is one of ARM, NULL, MIPS, POWER, SPARC,
-or X86. This will build an optimized version of the gem5 binary (gem5.opt)
-for the the specified architecture. See
-http://www.gem5.org/documentation/general_docs/building for more details
and
-options.
+build/<CONFIG>/gem5.opt' where CONFIG is one of the options in build_opts
like
+ARM, NULL, MIPS, POWER, SPARC, X86, Garnet_standalone, etc. This will
build an
+optimized version of the gem5 binary (gem5.opt) with the the specified
+configuration. See http://www.gem5.org/documentation/general_docs/building
for
+more details and options.
-The basic source release includes these subdirectories:
+The main source tree includes these subdirectories:
+ - build_opts: pre-made default configurations for gem5
+ - build_tools: tools used internally by gem5's build process.
- configs: example simulation configuration scripts
- ext: less-common external packages needed to build gem5
+ - include: include files for use in other programs
+ - site_scons: modular components of the build system
- src: source code of the gem5 simulator
- system: source for some optional system software for simulated systems
- tests: regression tests
- util: useful utility programs and files
-To run full-system simulations, you will need compiled system firmware
-(console and PALcode for Alpha), kernel binaries and one or more disk
-images.
+To run full-system simulations, you may need compiled system firmware,
kernel
+binaries and one or more disk images, depending on gem5's configuration and
+what type of workload you're trying to run.
If you have questions, please send mail to gem5-us...@gem5.org
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/50755
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: Id2fb9323dcb9d8bf8e86c78fb5e9aa6afed1c5b8
Gerrit-Change-Number: 50755
Gerrit-PatchSet: 1
Gerrit-Owner: Gabe Black <gabe.bl...@gmail.com>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
