Browse Source

Doc: Add cloning and build instructions to readme

master
Riyyi 2 years ago
parent
commit
b05c0404c6
  1. 36
      README.org

36
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]]

Loading…
Cancel
Save