Updated readme

renamed linux setup script
This commit is contained in:
Robin Jones 2016-12-13 11:47:00 +00:00
parent 63872f6e61
commit 42b5d9e09e
3 changed files with 48 additions and 116 deletions

160
README.md
View File

@ -1,36 +1,19 @@
# alt64
# Altra64
Alternative Everdrive64 menu
Kuroneko!
:\ /; _
; \___/ ; ; ;
,:-"' `"-:. / ;
_ /,---. ,---.\ _ _; /
_:>(( | ) ( | ))<:_ ,-""_,"
\````` `````/""""",-""
'-.._ v _..-' )
/ ___ ____,.. \
/ / | | | ( \. \
ctr / / | | | | \ \
`" `" `" `"
nyannyannyannyannyannyannyannyannyannyannyannyannyannyannyannyannyan
`alt64` is an open source menu for [Everdrive64](http://krikzz.com/). It was
`Altra64` is an open source menu for [Everdrive64](http://krikzz.com/) and is based on a fork of alt64 which was
originally written by saturnu, and released on the
[Everdrive64 forum](http://krikzz.com/forum/index.php?topic=816.0).
## Building
If you want to build the menu, you need an n64 toolchain. We'll use the
toolchain recommended by libdragon, with some updated versions.
If you want to build the menu, you need an n64 toolchain. When using windows 10, installation is totally automated through a script.
### Dependencies
* [libdragon](https://github.com/parasyte/libdragon)
### Dependencies (installed automatically)
* Windows 10 (Aniversary Update or above) / Ubuntu 16.04 (or above)
* [libdragon](https://github.com/DragonMinded/libdragon)
* [libmikmod-n64](https://github.com/parasyte/libmikmod-n64)
* [libmad-n64](https://github.com/parasyte/libmad-n64)
* [libyaml](http://pyyaml.org/wiki/LibYAML)
@ -39,101 +22,50 @@ toolchain recommended by libdragon, with some updated versions.
*You may skip this step if it's already installed.*
Clone the `libdragon` repo and create a directory for the build.
Clone this `Altra64` repo to a directory of your choice.
```bash
$ git clone https://github.com/parasyte/libdragon.git
$ mkdir libdragon/build_gcc
$ cp libdragon/tools/build libdragon/build_gcc
$ cd libdragon/build_gcc
On Windows 10, browse to the tools directory and double click on setup-wsfl.cmd
On Ubuntu, browse to the tools directory and run the command ```chmod +x ./setup-linux.sh;source ./setup-linux.sh```
### Build `Altra64`
To build the Rom
from the projects root directory,
On Windows 10 run
```
Modify the `build` script to set your installation path. Here is the default:
```bash
# EDIT THIS LINE TO CHANGE YOUR INSTALL PATH!
export INSTALL_PATH=/usr/local/mips64-elf
> build
```
Build it! This can take an hour or more.
```bash
$ ./build
on linux
```
### Configure your Environment
Add the following environment variable to your `~/.bash_profile` or `~/.bashrc`
Be sure to use the same path that you configured in the build script!
```bash
export N64_INST=/usr/local/mips64-elf
```
### Build `libdragon`
Make sure you are in the `libdragon` top-level directory, and make sure `libpng`
is installed:
```bash
$ make && make install
$ make tools && make tools-install
```
### Build `libmikmod`
Clone `libmikmod-n64` and build:
```bash
$ git clone https://github.com/parasyte/libmikmod-n64.git
$ cd libmikmod-n64
$ make
$ make install
```
### Build `libmad-n64`
Clone `libmad-n64` and build, be sure to set the path according to your
toolchain installation path:
```bash
$ git clone https://github.com/parasyte/libmad-n64.git
$ cd libmad-n64
$ export PATH=$PATH:$(N64_INST)/bin
$ CFLAGS="-march=vr4300 -mtune=vr4300 -mno-extern-sdata" \
LDFLAGS="-L$(N64_INST)/lib" LIBS="-lc -lnosys" \
./configure --host=mips64-elf --disable-shared \
--prefix=$(N64_INST) --enable-speed --enable-fpm=mips
$ make
$ make install
```
### Build `libyaml`
Download libyaml 0.1.6 and build, be sure to set the path according to your
toolchain installation path:
```bash
$ hg clone https://bitbucket.org/xi/libyaml
$ cd libyaml
$ hg update 0.1.6
$ ./bootstrap
$ export PATH=$PATH:$(N64_INST)/bin
$ CFLAGS="-std=gnu99 -march=vr4300 -mtune=vr4300" \
LDFLAGS="-L$(N64_INST)/lib -Tn64ld.x" \
LIBS="-ldragon -lc -ldragonsys -lnosys" \
./configure --host=mips64-elf --prefix=$(N64_INST)
$ make
$ make install
```
### Build `alt64`
Finally, we can clone `alt64` and build it!
```bash
$ git clone https://github.com/parasyte/alt64.git
$ make
```
If it all worked, you will find `OS64.v64` in the `alt64` bin directory.
### Debug Build `Altra64`
To build the debug version of the Rom
from the projects root directory,
On Windows 10 run
```
> build debug
```
on linux
```
$ make debug
```
### Clean `Altra64`
Finally, we can clean the build objects from the project
from the projects root directory,
On Windows 10 run
```
> build clean
```
on linux
```
$ make clean
```
If it all worked, you will find `OS64.v64` in the `Altra64` bin directory.

View File

@ -48,8 +48,8 @@ if '%1'=='ELEV' (del "%vbsGetPrivileges%" 1>nul 2>nul & shift /1)
lxrun /install /y
bash -c "echo 'export N64_INST=/usr/local/libdragon' >> ~/.bashrc; source ~/.bashrc"
bash -c "chmod +x ./setup-wsfl.sh"
bash --verbose -c "source ./setup-wsfl.sh"
bash -c "chmod +x ./setup-linux.sh"
bash --verbose -c "source ./setup-linux.sh"
::bash