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

Improve setup docs and add some helper symlinks. #223

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve setup docs and add some helper symlinks. #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b321b1f
Improve setup docs and add some helper symlinks.
enzanki-ars Mar 12, 2020
ba48131
Merge branch 'master' into improve-setup-instructions
dtracers May 2, 2020
207dbbc
Update README.md
dtracers May 2, 2020
1407c85
Update benchmarking.yml
dtracers May 2, 2020
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
2 changes: 1 addition & 1 deletion .github/workflows/benchmarking.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

name: Benchmarking

on: push
on: [push, pull_request]

jobs:
build:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ build/
carball.egg*
dist/
*ipynb*
protobuf-*
carball/generated/binaries/protoc

!/carball/tests/replays/
.vscode
41 changes: 23 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,6 @@ Carball is an open-source project that combines multiple tools for decompiling R

`pip install carball`

#### Clone for development

##### Windows
```
git clone https://github.com/SaltieRL/carball
cd carball/
python init.py
```

##### Linux
```
git clone https://github.com/SaltieRL/carball
cd carball/
./_travis/install-protoc.sh
python init.py
```

## Examples / Usage
One of the main data structures used in carball is the pandas.DataFrame, to learn more, see [its wiki page](https://github.com/SaltieRL/carball/wiki/data_frame).

Expand Down Expand Up @@ -175,6 +158,28 @@ Fix:
## Developing
Everyone is welcome to join the carball (and calculated.gg) project! Even if you are a beginner, this can be used as an opportunity to learn more - you just need to be willing to learn and contribute.

#### Clone for development

##### Windows
```
git clone https://github.com/SaltieRL/carball
cd carball/
python init.py
```

##### Linux
```
git clone https://github.com/SaltieRL/carball
cd carball/
chmod +x _travis/install-protoc.sh
./_travis/install-protoc.sh 2.6.1
mkdir -p carball/generated/binaries/.libs/
ln -s ../../../protobuf-2.6.1/src/.libs/ carball/generated/binaries/
pip3 install -r requirements.txt
pip3 install -r requirements-test.txt
python3 init.py
```

### Usage of GitHub
All contributions end up on the carball repository. If you are new to the project you are required to use your own fork for first changes. If you do not have any previous git / github experience that is completely fine - we can help with it.
If we believe that you are comitted to working on the project and have experience in git we may give you write access so that you no longer have to use a fork. Nonetheless, please wait until your contrubtion is ready for a review to make the pull request because that will save resources for our tests and reduce spam.
Expand Down Expand Up @@ -202,5 +207,5 @@ If you wish to see the current carball analysis performance, it is split into 5
* A full game of rumble - to test rumble performance.
* [RLCS](https://saltierl.github.io/carball/dev/bench/oce_rlcs/)
* A full soccar RLCS game.
* [RLCS (Intensive)](https://saltierl.github.io/carball/dev/bench/oce_rlcs_intensive/)
* [RLCS (Intensive)](https://saltierl.github.io/carball/dev/bench/intensive_oce_rlcs/)
* A full soccar RLCS game, but run with the intense analysis flag.
Empty file modified _travis/install-protoc.sh
100644 → 100755
View file
Open in desktop
Empty file.
1 change: 1 addition & 0 deletions carball/generated/binaries/.libs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../protobuf-2.6.1/src/.libs/