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.

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

Added guidelines for Linux #26

Merged
merged 1 commit into from
Jul 5, 2024
Merged
Changes from all commits
Commits
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
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,41 @@

This package provides a Julia wrapper for the [OpenSpiel](https://github.com/deepmind/open_spiel) project. For more details, please refer the [doc](https://openspiel.readthedocs.io/en/latest/julia.html)

For higher level APIs you may refer [ReinforcementLearningEnvironments.jl](https://github.com/JuliaReinforcementLearning/ReinforcementLearningEnvironments.jl).
For higher level APIs you may refer [ReinforcementLearningEnvironments.jl](https://github.com/JuliaReinforcementLearning/ReinforcementLearningEnvironments.jl).

# Installation Guidelines

## Linux:
## 1. Install Julia with specific version:
- To install latest stable version:
```
curl -fsSL https://install.julialang.org | sh
```
- To install long term support version:
```
sudo snap install julia --classic --channel=lts
```
Suggested to use LTS version to avoid errors with OpenSpiel.jl

## 2. Add OpenSpiel.jl wrapper to your Julia Repl:
- Open terminal and start a Julia terminal by running the executable

```
julia
```
- Open Packages

```
julia> ]
```
- Add the below command

```
pkg> add https://github.com/JuliaReinforcementLearning/OpenSpiel.jl.git
```
- To test if it installed correctly run the below code in your Julia repl

```
using OpenSpiel
```

Loading