riyyi/garbage
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doc: Add contributing section to readme

Browse Source
This commit is contained in:
Riyyi
2022-08-18 20:37:27 +02:00
parent 22f3ed8b84
commit 0db89cf109
1 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.org
+12 -4
View File
@@ -9,32 +9,40 @@ 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 #+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 ** Libraries
- [[https://github.com/riyyi/ruc][ruc]] - [[https://github.com/riyyi/ruc][ruc]]