From ce85d3a0f454bec61ef1cdecfdc693f6da5449dc Mon Sep 17 00:00:00 2001 From: jothi-prasath Date: Fri, 19 May 2023 22:23:13 +0530 Subject: [PATCH] added getting started section --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 2e3b141..5fedf79 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,37 @@ This respository contains the ASM Rosetta Stone, a small snippet of C that you can use to learn a new assembly variant in a short amount of time. +## Getting Started +To get started with studying assembly languages using Rosetta Stone, follow these steps: + +1. **Clone the repository**: Open a terminal and run the following command to clone the repository to your local machine: + +``` +git clone https://github.com/lowlevellearning/rosetta-stone.git +``` +2. **Install necessary packages**: Install the necessary packages on your system by running the following command: +``` +./setup.sh +``` +3. **Makefile usage**: You can use the Makefile to compile the rosetta.c file into executables for different architectures. Run the following command to compile the code for all supported architectures (powerpc, arm, aarch64): +``` +make all +``` +Alternatively, you can compile the code for individual architectures using the respective target names: +* **PowerPC:** +``` +make powerpc +``` +* **ARM** +``` +make arm +``` +* **AArch64** +``` +make aarch64 +``` +The compiled executables will be named ppc (for powerpc), arm (for arm), and aarch64 (for aarch64). + ## Checklist - registers - names []