Skip to content

Commit

Permalink
Add basic build steps to README
Browse files Browse the repository at this point in the history
  • Loading branch information
iWas-Coder committed May 18, 2024
1 parent 048f942 commit c7b1507
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.org
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,34 @@ brew install rust jq

** Compilation & Linkage

(...)
#+begin_example
Targets
=======
all :: Build all targets marked with [*]
,* checkdeps :: Check dependencies for build process
,* game :: Build the bare game
check :: Build and run the test engine
editor :: Build the editor
clean :: Remove the 'build' directory
mrproper :: Remove and cleans everything
version :: Show the current version string
help :: Show this help and usage panel

Execute 'make' or 'make all' to build all targets marked with [*]
For further info see the ./README.org file
#+end_example

To build the game, issue the following command:

#+begin_src sh
make
#+end_src

Next, run the test suite:

#+begin_src sh
make check
#+end_src

* Binary distributions

Expand Down

0 comments on commit c7b1507

Please sign in to comment.