gu-zu / ryb

Group 10 RYB project

Rocky You Baby

This is TU/e EE group 10 Rock You Baby projects codebase.

Setup to just run and see how it works

You will not be able to push code here. Installation

$ git clone https://github.com/onixtsm/ryb
$ cp ryb {pynq_board_any_place}
$ cd {pynq_board_any_place}/ryb
$ make # can use make -j 4 to compile faster

Setup so you can edit code here

Follow these steps to contribute this project.

1. Make Github accout
2. Fork this project
3. Clone it with

$ git clone https://github.com/[username]/ryb

4. Make new branch with command

$ git checkout -b [branch name]

5. Edit code
6. Commit all changes (message should be meaningful and well describing your changes)

$ git add [files or dirs you changes]
$ git commit

7. Push changes to your account

$ git push

8. Make pull request on github

Getting newest chages

$ git pull -p

Coding rules

All code is placed in src/ directory To recompile code run make from root of the project If you want to compile code on your computer (for instance you do not need any pynqboard IO), you can use make nopynq=1. If you do that you need to recompile whole library with this option. You can indent code by runing

$ make indent

Compiled code is in ./build/main

Do not forget to make and include header file if you created a .c file If you create header file add header guard to it. For now it compiles everything in main file, but it will be changed when it is needed.

To run the code you can use

$ make run
# or
$ ./build/main

Learning material

• freecodecamp
• git-scm
• freecodecamp youtube
• Making pull request

P.S.

DOCUMENT YOUR CODE