pmret/papermario
1
0
Fork 0
mirror of https://github.com/pmret/papermario.git synced 2024-11-08 12:02:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

add format.sh info to readme

Browse Source
This commit is contained in:
Alex Bates 2020-08-18 01:04:39 +01:00
parent 852ab4a25d
commit 19c9a82b2a
No known key found for this signature in database
GPG Key ID: 5E11C2DB78877706
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -94,6 +94,16 @@ You're on your own now. Get your C code compiling to match the original assembly
If you use Visual Studio Code, you can use _Run Test Task_ to run `diff.py` and show you errors and warnings from the compiler inline. You might want to attach _Run Test Task_ to a keybinding, as you'll be using it often. If you use Visual Studio Code, you can use _Run Test Task_ to run `diff.py` and show you errors and warnings from the compiler inline. You might want to attach _Run Test Task_ to a keybinding, as you'll be using it often.
#### Formatting and linting
Once your function is matching, you'll want to make a pull request. Before you do that, run the following script to reformat your code. (You can also format specific files with `./format.sh path/to/file.c`.)
```sh
$ ./format.sh
```
If `format.sh` displays any errors, go and fix them. If you can't fix them without breaking the function from matching, append `// NOLINT` to the offending line.
## FAQ ## FAQ
* If you received the following error when running `make`: * If you received the following error when running `make`: