Browse Source

Doc: Add contributing section to readme

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

36
README.org

@ -9,30 +9,38 @@ Accurate GameBoy emulator.
*** Clone *** Clone
#+BEGIN_SRC sh #+BEGIN_SRC shell-script
$ git clone https://gitlab.com/riyyi/garbage $ git clone https://gitlab.com/riyyi/garbage
$ cd garbage $ cd garbage
$ git submodule init $ git submodule init
$ git submodule update $ git submodule update
#+END_SRC #+END_SRC
Or Or
#+BEGIN_SRC sh #+BEGIN_SRC shell-script
$ git clone --recursive https://gitlab.com/riyyi/garbage $ git clone --recursive https://gitlab.com/riyyi/garbage
#+END_SRC #+END_SRC
*** Update *** Update
#+BEGIN_SRC sh #+BEGIN_SRC shell-script
$ git pull $ git pull
$ git submodule update --recursive $ git submodule update --recursive
#+END_SRC #+END_SRC
** Build instructions ** Build instructions
#+BEGIN_SRC sh #+BEGIN_SRC shell-script
$ mkdir build $ mkdir build
$ cd build $ cd build
$ cmake .. && make $ cmake .. && make
#+END_SRC
** Contributing
Enable 'commit-hooks' to lint your changes before committing them.
#+BEGIN_SRC shell-script
$ ./vendor/ruc/script/pre-commit.sh install
#+END_SRC #+END_SRC
** Libraries ** Libraries

Loading…
Cancel
Save