From b05c0404c642d3c96a7e4847825975d3391766d9 Mon Sep 17 00:00:00 2001 From: Riyyi Date: Wed, 17 Aug 2022 18:28:33 +0200 Subject: [PATCH] Doc: Add cloning and build instructions to readme --- README.org | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 1d12d46..bf089ab 100644 --- a/README.org +++ b/README.org @@ -3,4 +3,38 @@ #+LANGUAGE: en #+OPTIONS: toc:nil -Accurate GameBoy Emulator. +Accurate GameBoy emulator. + +** Download + +*** Clone + +#+BEGIN_SRC sh + $ git clone https://gitlab.com/riyyi/garbage + $ cd garbage + $ git submodule init + $ git submodule update +#+END_SRC +Or +#+BEGIN_SRC sh + $ git clone --recursive https://gitlab.com/riyyi/garbage +#+END_SRC + +*** Update + +#+BEGIN_SRC sh + $ git pull + $ git submodule update --recursive +#+END_SRC + +** Build instructions + +#+BEGIN_SRC sh + $ mkdir build + $ cd build + $ cmake .. && make +#+END_SRC + +** Libraries + +- [[https://github.com/riyyi/ruc][ruc]]