csc230-autoformat/README.md

21 lines
400 B
Markdown

# csc230-autoformat
## Requirements
- zsh
- astyle 2.04+
- perl
- doxygen (optional, for checking if all code is documented)
## Usage
```sh
cd path/with/code/
git clone https://github.ncsu.edu/agadler/csc230-autoformat ../autoformat
../autoformat/autoformat.sh
```
## Known Issues
- Automatically formatting this doesn't work (`(true)` doesn't get placed after `while ``): ```
while
(true) {}
```