From 0db89cf109df48515c502dc1076ea8f90488c4d6 Mon Sep 17 00:00:00 2001 From: Riyyi Date: Thu, 18 Aug 2022 20:37:27 +0200 Subject: [PATCH] Doc: Add contributing section to readme --- README.org | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.org b/README.org index 091923a..eb11952 100644 --- a/README.org +++ b/README.org @@ -9,30 +9,38 @@ Accurate GameBoy emulator. *** Clone -#+BEGIN_SRC sh - $ git clone https://gitlab.com/riyyi/garbage - $ cd garbage - $ git submodule init - $ git submodule update +#+BEGIN_SRC shell-script +$ 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 +#+BEGIN_SRC shell-script +$ git clone --recursive https://gitlab.com/riyyi/garbage #+END_SRC *** Update -#+BEGIN_SRC sh - $ git pull - $ git submodule update --recursive +#+BEGIN_SRC shell-script +$ git pull +$ git submodule update --recursive #+END_SRC ** Build instructions -#+BEGIN_SRC sh - $ mkdir build - $ cd build - $ cmake .. && make +#+BEGIN_SRC shell-script +$ mkdir build +$ cd build +$ 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 ** Libraries