https://github.com/b1gbyt3/macos-riverspider
A script to automatically install and configure the riverSpider environment on macOS.
https://github.com/b1gbyt3/macos-riverspider
automation bash command-line homebrew java logisim macos mise osx shell-script utility zsh
Last synced: 3 months ago
JSON representation
A script to automatically install and configure the riverSpider environment on macOS.
- Host: GitHub
- URL: https://github.com/b1gbyt3/macos-riverspider
- Owner: b1gbyt3
- License: agpl-3.0
- Created: 2025-05-02T04:05:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-11T02:47:51.000Z (about 1 year ago)
- Last Synced: 2025-07-08T09:54:18.454Z (12 months ago)
- Topics: automation, bash, command-line, homebrew, java, logisim, macos, mise, osx, shell-script, utility, zsh
- Language: Shell
- Homepage:
- Size: 110 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# riverSpider macOS Setup Script
[](https://github.com/b1gbyt3/macOS-riverSpider/actions/workflows/test-macos-install.yml)
**Full Install Time Estimate:** <5 mins
Includes:
* Downloading and installing `Homebrew`
* Installing necessary packages (`coreutils`, `mise`, `wget`, `fd`)
* Setting up latest `Java OpenJDK`
* Downloading and unzipping `riverSpiderForMac.zip`
*Note: Actual time may vary based on your hardware and internet speed. (Tested on M1 Max 10-core, 64GB RAM, 250Mbps connection).*
## Before Install (Required)
**Grant Full Disk Access to Terminal:**
1. Go to **System Settings > Privacy & Security > Full Disk Access**.
2. Click **+**, navigate to `Applications/Utilities/`, select **Terminal.app**, and click **Open**.
3. Ensure the switch next to Terminal is **ON**.
## Install
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/b1gbyt3/macOS-riverSpider/HEAD/install.sh)"
```
* Installs: [Homebrew](https://brew.sh), [mise](https://github.com/jdx/mise?tab=readme-ov-file#what-is-it), [fd](https://github.com/sharkdp/fd?tab=readme-ov-file#fd), [wget](https://www.gnu.org/software/wget/), [coreutils](https://www.gnu.org/software/coreutils/), [OpenJDK](https://openjdk.org)
* Adds: easy to use shell function to your config file:
* `riverspider` - runs `riverSpider/submit.sh` on passed file **(from anywhere)**
* ## Usage
```bash
riverspider
```
* `logisim` - opens Logisim (from anywhere)
* ## Usage
```bash
logisim [your_file.circ]
```
> Note: `[your_file.circ]` is optional
* `logproc` - opens `processor0004.circ` in Logisim **(from anywhere)**
* `logalu` - opens `alu.circ` in Logisim **(from anywhere)**
* `logreg` - opens `regbank.circ` in Logisim **(from anywhere)**
## After Install (Required)
* Source config:
* `source ~/.zprofile` (Zsh)
* `source ~/.bash_profile` (Bash)
* Or restart terminal
## LIMITATIONS
### Shell Config Files
> NOTE: CURRENTLY ONLY WORKS ON [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) AND [zsh](https://en.wikipedia.org/wiki/Z_shell)
* Defaults:
* `~/.zprofile` (Zsh)
* `~/.bash_profile` (Bash)
* **Using different files?**
```bash
git clone https://github.com/b1gbyt3/macOS-riverSpider.git && cd macOS-riverSpider
```
* Edit in `install.sh`:
```bash
# --- Shell Settings Filenames ---
# Default names for the shell configuration files.
# You might need to change these if you use different filenames like '.zshrc' or '.bashrc'.
readonly ZSH_PROFILE_BASENAME=".zprofile" # For Zsh shell
readonly BASH_PROFILE_BASENAME=".bash_profile" # For Bash shell
```
* Run: `chmod +x install.sh && ./install.sh`
### ⚠️ No Spaces in Paths!
* ✅ GOOD: `~/CISP_310/riverSpider/`
* ❌ BAD: `~/CISP 310/riverSpider/`
* ✅ GOOD: `~/CISP310/riverSpider/my-file.ttpasm`
* ❌ BAD: `~/CISP_310/riverSpider/my file.ttpasm`
> NO this `~/"CISP 310"/riverSpider/` and `~/CISP\ 310/riverSpider/` **DOESN'T FIX IT**