Skip to content

Commit

Permalink
Merge pull request #27 from MAPF-Competition/nobodyczcz-patch-1
Browse files Browse the repository at this point in the history
Update README.md typo
  • Loading branch information
nobodyczcz authored Aug 5, 2023
2 parents d007dc0 + 102505a commit 1f52e03
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## Join the competition

Login to the [competition website](http://www.leagueofrobotrunners.org/) with a GitHub account, and we will automatically create a private GitHub submission repo for you.
The repo will be the place that you submit codes to. In the `My Submission` page, you can click "My Repo" to open your GitHub submission repo page.
Log in to the [competition website](http://www.leagueofrobotrunners.org/) with a GitHub account, and we will automatically create a private GitHub submission repo for you.
The repo will be the place where you submit codes. In the `My Submission` page, you can click "My Repo" to open your GitHub submission repo page.

## Clone your submission repo

Clone your submission repo to your local machine. The repo contains starter code to help you prepare your submission.
Clone your submission repo to your local machine. The repo contains starter codes to help you prepare your submission.

```
$ git clone git@github.com:your_submission_repo_address
Expand All @@ -31,7 +31,7 @@ make -j

## Run the start kit

Runing startkit using command:
Running the start-kit using commands:
```shell
./lifelong --inputFile the_input_file_name -o output_file_location
```
Expand All @@ -48,15 +48,15 @@ more info on help:

## Upgrade Your Start-Kit

If your private startk-kit copy repo was created before a start-kit upgrade, you need to run the `./upgrade_start_kit.sh` to upgrade your start-kit to the latest version.
If your private start-kit copy repo was created before a start-kit upgrade, you could run the ./upgrade_start_kit.sh to upgrade your start-kit to the latest version.

You can check `version.txt` to know the current version of your start-kit.
You can check version.txt to know the current version of your start-kit.

The `upgrade_start_kit.sh` will check which file is marked as upgrade needed and pull thoese files from start-kit.
The upgrade_start_kit.sh will check which file is marked as an upgrade needed and pull those files from the start-kit.

The upgrade may overwrite some of your changes to `CMakeLists.txt` and `apt.txt`, you could compare the difference using `git diff` and decided wether to revert some changes on these files.
The upgrade may overwrite some of your changes to CMakeLists.txt and apt.txt, you could compare the difference using git diff and decide whether to revert some modifications on these files.

The upgrade script will not touch any participants created file, `python/pyMAPFPlanner.py`, `inc/MAPFPlanner.h` and `src/MAPFPlanner.cpp`. So that participants implementations should not be influnced by the start-kit upgrade.
The upgrade script will not touch any participants' created file, python/pyMAPFPlanner.py, inc/MAPFPlanner.h and src/MAPFPlanner.cpp. So that participants' implementations should not be influenced by the start-kit upgrade.

## Input output description

Expand All @@ -67,9 +67,9 @@ Please refer to the [Input_Output_Format.md](./Input_Output_Format.md).
Please refer to the [Prepare_Your_Planner.md](./Prepare_Your_Planner.md).

## Visualisation
We provide a visualisattion tool written in python: [https://github.com/MAPF-Competition/MAPF_analysis](https://github.com/MAPF-Competition/MAPF_analysis).
We provide a visualisation tool written in Python: [https://github.com/MAPF-Competition/MAPF_analysis](https://github.com/MAPF-Competition/MAPF_analysis).

It is able to visualise the output of start-kit program and help participants to debug the implementations.
It is able to visualise the output of the start-kit program and help participants to debug the implementations.

## Submission Instruction

Expand Down

0 comments on commit 1f52e03

Please sign in to comment.