Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #74

Merged
merged 1 commit into from
May 22, 2024
Merged

Update README.md #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,36 @@ Programming language that compiles to Bash. It's a high level programming langua
> This software is not ready for extended usage.

## Install
This compiler currently works on Windows (WSL), Linux and MacOS - all x86 and ARM 64 bit.
Amber compiler currently works on:
- Linux x86 and ARM
- macOS x86 and ARM (Apple Silicon)

### MacOS
### macOS / Linux
Make sure that the operating system meets the following prerequisites
- Bash or Zsh or any other Bourne-again shell (usually comes with MacOS)
- Ruby 2.0 or newer (usually comes with MacOS)

```bash
sudo ruby -e "require 'open-uri'; puts open('https://raw.githubusercontent.com/Ph0enixKM/AmberNative/master/setup/install.sh').read" | $(echo $SHELL)
```

### Linux
Make sure that the operating system meets the following prerequisites
- Bash or Zsh or any other Bourne-again shell
- Bourne-again shell (Bash)
- Curl tool for downloading the installation script
- Basic calculator `bc` command (On Debian run `sudo apt install bc`)

```bash
sudo curl https://raw.githubusercontent.com/Ph0enixKM/AmberNative/master/setup/install.sh | $(echo $SHELL)
curl -s "https://raw.githubusercontent.com/Ph0enixKM/AmberNative/master/setup/install.sh" | $(echo /bin/bash)
```

#### Via a package manager
Amber is packaged in the following distros:

Arch (AUR) - `amber-bash`

### Windows support
As windows does not come with bash installed it makes no sense to support it. Please install WSL 2 on your windows machine and install Linux version of Amber compiler inside.

In order for it to work you may need to run the following code that pulls all the prerequisites.

```bash
sudo apt install curl bc
sudo mkdir /opt /usr/local/bin
```


## Contributing
In order to contribute, you have to add couple of build targets:
```bash
Expand Down