summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorfig02 <fig02srl@gmail.com>2022-02-20 08:51:12 -0500
committerGitHub <noreply@github.com>2022-02-20 08:51:12 -0500
commit5b0f79ec6ed8003585466f8d0b7c7d2a07c3664d (patch)
treee81edcb35b9f7f73d28252661103ad5c8a12928e /docs
parente51fd737040352ab366a2bc531b60858f3b00aae (diff)
Update cygwin instructions (#1146)
* update readme * fixes * update permissions for various things * typos
Diffstat (limited to 'docs')
-rw-r--r--docs/BUILDING_CYGWIN.md69
1 files changed, 35 insertions, 34 deletions
diff --git a/docs/BUILDING_CYGWIN.md b/docs/BUILDING_CYGWIN.md
index a673bdd73..8508ec0fa 100644
--- a/docs/BUILDING_CYGWIN.md
+++ b/docs/BUILDING_CYGWIN.md
@@ -1,34 +1,46 @@
# Building with Cygwin
-**N.B.** These have not been tested recently, you may find the requirements have changed a bit.
-
If you want to use Cygwin, you will need to:
-## 1. Install Git Bash and Cygwin
+## 1. Install Cygwin (and required packages)
-* Download and install [Git Bash](https://git-scm.com/download/win).
* Download and install [Cygwin](https://cygwin.com).
+Run the installer and follow the steps to install a cygwin terminal.
+
+After the "choose a download site" step, a window will pop up which will allow you to select packages.
+Unlike a normal linux distribution, you must install packages from this interface within the setup program.
+To install a package you can change View from "Pending" to "Full".
+Then you can enter a package name to search. After finding the package you want, change the "Skip" drop down
+to the version you want to install.
+
+Use this interface to select the latest version for all of the following packages:
+* make
+* gcc-g++
+* bison
+* flex
+* texinfo
+* git
+* libiconv
+* dos2unix
+* python3
+* libpng-devel
+* binutils (Make sure to check the "Src?" checkbox since we're interested in the source code)
## 2. Build mips-linux-binutils on Windows using Cygwin
-
-First, you will need to install the following packages using the Cygwin installer:
-- make
-- gcc-g++
-- bison
-- flex
-- texinfo
-- binutils (Make sure to check the "Src?" checkbox since we're interested in the source code. Once the download is finished, you will find it in `/usr/src/`)
+For the following instructions, wherever you see `binutils-[...]`, the [...] represents the version number.
+You can use tab auto-complete to fill this in.
Create destination dir for binutils
```bash
-sudo mkdir -p /opt/cross
+mkdir -p /opt/cross
```
+
Extract binutils source
```bash
cd /usr/src/binutils-[...].src/
-tar xjf binutils-[...].tar.bz2
+tar -xf binutils-[...].tar.xz
```
Create and enter build dir
@@ -39,33 +51,23 @@ cd build-binutils
Configure the build
```bash
-../binutils-gdb/configure --target=mips-linux-gnu --prefix=/opt/cross --disable-gprof --disable-nls --disable-werror --disable-gdb --disable-libdecnumber --disable-readline --disable-sim
+../binutils-[...]/configure --target=mips-linux-gnu --prefix=/opt/cross --disable-gprof --disable-nls --disable-werror --disable-gdb --disable-libdecnumber --disable-readline --disable-sim
```
Make and install binutils
```bash
make -j
-sudo make install -j
+make install -j
```
Add the new binutils binaries to your system PATH:
+- Go to your home directory `cd`
+- Open windows explorer in your current location `explorer.exe .`
+- Open the `.bashrc` file in a text editor
+- Scroll to the bottom and add `PATH=$PATH:/opt/cross/bin` to a new line and save the file
+- Run `source .bashrc` or close and reopen cygwin
-You can do that by adding `PATH=$PATH:/opt/cross/bin` to `~/.bashrc` and then reloading `~/.bashrc`.
-
-Alternatively you can edit the `Path` variable in `Edit the system environment variables`>`Environment Variables` (in which case you will need to relaunch your terminal).
-
-
-## 3. Install required Cygwin packages
-
-Once mips-linux-binutils is installed you will need to install the following packages using Cygwin's installer:
-
-* libiconv
-* dos2unix
-* python3
-* libpng-devel
-
-
-## 4. Install required Python packages
+## 3. Install required Python packages
To install the Python dependencies simply run in a terminal:
@@ -73,8 +75,7 @@ To install the Python dependencies simply run in a terminal:
python3 -m pip install colorama
```
-
-## 5. Continue with Linux instructions
+## 4. Continue with Linux instructions
You should be able to continue from step [step 2](../README.md#2-clone-the-repository) of the Linux instructions.