mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
Update README to point to online install instructions
This commit is contained in:
ISSOtm
148
README.rst
148
README.rst
@@ -21,155 +21,25 @@ found in this repository.
|
|||||||
1. Installing RGBDS
|
1. Installing RGBDS
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
1.1 Windows
|
The `installation procedure <https://rgbds.gbdev.io/install>`__ is available
|
||||||
~~~~~~~~~~~
|
online for various platforms. `Building from source <https://rgbds.gbdev.io/install/source>`__
|
||||||
|
is possible using ``make`` or ``cmake``; follow the link for more detailed instructions.
|
||||||
Windows builds are available in the releases page on GitHub
|
|
||||||
`here <https://github.com/rednex/rgbds/releases>`__.
|
|
||||||
|
|
||||||
Extract the zip and then add the executable directory to the path. For example:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
path %PATH%;C:\Programs\rgbds-0.3.8-win64\win64
|
|
||||||
|
|
||||||
Alternatively, the RGBDS executables can be simply dropped in the folder of the project they're used in.
|
|
||||||
|
|
||||||
If you require the latest version in development, it should be possible to
|
|
||||||
compile RGBDS with MinGW or Cygwin by following the instructions to build it on
|
|
||||||
UNIX systems.
|
|
||||||
|
|
||||||
1.2 macOS
|
|
||||||
~~~~~~~~~
|
|
||||||
|
|
||||||
You can build RGBDS by following the instructions below. However, if you would
|
|
||||||
prefer not to build RGBDS yourself, you may also install it using
|
|
||||||
`Homebrew <http://brew.sh/>`__.
|
|
||||||
|
|
||||||
To install the latest release, use:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
brew install rgbds
|
|
||||||
|
|
||||||
To install RGBDS with all of the current changes in development (as seen on the
|
|
||||||
``master`` branch on GitHub), use:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
brew install rgbds --HEAD
|
|
||||||
|
|
||||||
1.3 Arch Linux
|
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
To install RGBDS through the AUR run
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
yaourt -S rgbds
|
|
||||||
|
|
||||||
1.4 Other UNIX-like systems
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
No official binaries of RGBDS are distributed for these systems, you must follow
|
|
||||||
the simple instructions below to compile and install it.
|
|
||||||
|
|
||||||
2. Building RGBDS from source
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
RGBDS can be built in UNIX-like systems by following the instructions below.
|
|
||||||
|
|
||||||
2.1 Dependencies
|
|
||||||
~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
RGBDS requires yacc, libpng and pkg-config to be installed.
|
|
||||||
|
|
||||||
On macOS, install the latter two with `Homebrew <http://brew.sh/>`__:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
brew install libpng pkg-config
|
|
||||||
|
|
||||||
On other Unixes, use the built-in package manager. For example, on Debian or
|
|
||||||
Ubuntu:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
sudo apt-get install byacc flex pkg-config libpng-dev
|
|
||||||
|
|
||||||
You can test if libpng and pkg-config are installed by running ``pkg-config
|
|
||||||
--cflags libpng``: if the output is a path, then you're good, and if it outputs
|
|
||||||
an error then you need to install them via a package manager.
|
|
||||||
|
|
||||||
2.2 Build process
|
|
||||||
~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
To build the programs, run in your terminal:
|
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
make
|
make
|
||||||
|
sudo make install
|
||||||
Then, to install the compiled programs and manual pages, run (with appropriate
|
|
||||||
privileges, e.g, with ``sudo``):
|
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
make install
|
cmake -S . -B build
|
||||||
|
cmake --build build
|
||||||
|
cmake --install build
|
||||||
|
|
||||||
After installation, you can read the manuals with the ``man`` command. E.g.,
|
2. History
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
man 7 rgbds
|
|
||||||
|
|
||||||
There are some variables in the Makefile that can be redefined by the user. The
|
|
||||||
variables described below can affect installation behavior when given on the
|
|
||||||
make command line. For example, to install RGBDS in your home directory instead
|
|
||||||
of systemwide, run the following:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
make install PREFIX=$HOME
|
|
||||||
|
|
||||||
To do a verbose build, run:
|
|
||||||
|
|
||||||
.. code:: sh
|
|
||||||
|
|
||||||
make Q=
|
|
||||||
|
|
||||||
This is the complete list of user-defined variables:
|
|
||||||
|
|
||||||
- ``PREFIX``: Location where RGBDS will be installed. Defaults to
|
|
||||||
``/usr/local``.
|
|
||||||
|
|
||||||
- ``bindir``: Location where the binaries will be installed. Defaults to
|
|
||||||
``${PREFIX}/bin``.
|
|
||||||
|
|
||||||
- ``mandir``: Location where the manpages will be installed. Defaults to
|
|
||||||
``${PREFIX}/share/man``.
|
|
||||||
|
|
||||||
- ``DESTDIR``: This is prepended to all paths during the installation. It is
|
|
||||||
mainly used for packaging.
|
|
||||||
|
|
||||||
- ``Q``: Whether to quiet the build or not. To make the build more verbose,
|
|
||||||
clear this variable. Defaults to ``@``.
|
|
||||||
|
|
||||||
- ``STRIP``: Whether to strip the installed binaries of debug symbols or not.
|
|
||||||
Defaults to ``-s``.
|
|
||||||
|
|
||||||
- ``BINMODE``: Permissions of the installed binaries. Defaults to ``755``.
|
|
||||||
|
|
||||||
- ``MANMODE``: Permissions of the installed manpages. Defaults to ``644``.
|
|
||||||
|
|
||||||
- ``CHECKPATCH``: Path of the script ``checkpatch.pl`` of the Linux kernel.
|
|
||||||
Defaults to ``../linux/scripts/checkpatch.pl``.
|
|
||||||
You can retrieve that script from `here <https://github.com/torvalds/linux/blob/master/scripts/checkpatch.pl>`__.
|
|
||||||
|
|
||||||
3 History
|
|
||||||
---------
|
---------
|
||||||
|
|
||||||
- Around 1997, Carsten Sorensen (AKA SurfSmurf) writes ASMotor as a
|
- Around 1997, Carsten Sørensen (AKA SurfSmurf) writes ASMotor as a
|
||||||
general-purpose assembler/linker system for DOS/Win32
|
general-purpose assembler/linker system for DOS/Win32
|
||||||
|
|
||||||
- Around 1999, Justin Lloyd (AKA Otaku no Zoku) adapts ASMotor to read and
|
- Around 1999, Justin Lloyd (AKA Otaku no Zoku) adapts ASMotor to read and
|
||||||
|
|||||||
Reference in New Issue
Block a user