diff --git a/README.md b/README.md index aaec3eb..3aa7405 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ # dfmt Dfmt is a formatter for D source code -[![Build Status](https://travis-ci.org/Hackerpilot/dfix.svg)](https://travis-ci.org/Hackerpilot/dfix) +[![Build Status](https://travis-ci.org/Hackerpilot/dfmt.svg)](https://travis-ci.org/Hackerpilot/dfmt) + +## Status +*dfmt* is alpha-quality. Make backups of your files or use source control. + +## Building +### Using Make +* Clone the repository +* Run ```git submodule update --init``` in the dfmt directory +* To compile with DMD, run ```make``` in the dfmt directory. To compile with + LDC, run ```make ldc``` instead. The generated binary will be placed in + ```dfmt/bin/```. + +## Using +By default, dfmt reads its input from ```stdin``` and writes to ```stdout```. +If a file name is specified on the command line, input will be read from the +file instead, and output will be written to ```stdout```. If the ```--inplace``` +option is specified a file name is required and the file will be edited +in-place.