Skip to content

Commit

Permalink
Merge pull request #74 from Martan404/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Ph0enixKM authored May 22, 2024
2 parents 5a79e47 + 3f13765 commit eee1502
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
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

0 comments on commit eee1502

Please sign in to comment.