csc230-autoformat/README.md

21 lines
400 B
Markdown
Raw Normal View History

2016-08-19 11:08:38 -04:00
# csc230-autoformat
2016-08-19 11:30:26 -04:00
## Requirements
- zsh
- astyle 2.04+
- perl
2016-08-20 14:57:29 -04:00
- doxygen (optional, for checking if all code is documented)
2016-08-19 11:30:26 -04:00
## Usage
```sh
cd path/with/code/
git clone https://github.ncsu.edu/agadler/csc230-autoformat ../autoformat
../autoformat/autoformat.sh
```
2016-08-20 14:44:55 -04:00
## Known Issues
- Automatically formatting this doesn't work (`(true)` doesn't get placed after `while ``): ```
while
(true) {}
```