Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasFrey96 committed Feb 29, 2024
1 parent af1277c commit c4885ce
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,20 @@ Replace `leggedrobotics` with your `username`.
Small notice you can clone a repo using ssh or https.
I recommend to setup ssh-keys and always use ssh.

Then go to the Github Settings to right:
![alt text](docs/repo.jpg)


Activate under General the following Features:
![alt text](docs/features.jpg)

### Submission instructions
You at first create a fork of the plr-exercise repository under your local GitHub username.
For each task you create a branch called: `dev/task_X`
You commit all the changes necessary for this task to this branch and push the changes to GitHub.
To finish a task you create a pull request from `dev/task_X` to `main`.
The title of the pull request is the task description below.

Do not delete the branches after merging the PR.

Task Descriptions:
- **Task 0:** Run train.py and create an issue and complain about your low test score.
Expand Down Expand Up @@ -165,8 +170,8 @@ Add docstrings to all classes and functions: [https://peps.python.org/pep-0257/]
Here are some workflows by the RSL that may help you: [https://github.com/leggedrobotics/workflows](https://github.com/leggedrobotics/workflows)



## Things we did not cover
- Timing - check out the `timing.py` and try to understand why the times are different
- Typing
- GitHub Actions

Expand Down
Binary file added docs/features.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/repo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c4885ce

Please sign in to comment.