MyFavMirrors/markdown-resume
1
0
Fork 0
mirror of https://github.com/there4/markdown-resume.git synced 2024-12-03 08:59:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update the read me with information about the -r refresh option

Browse Source
This commit is contained in:
Craig Davis 2012-03-22 11:33:48 -05:00
parent e0e11658d7
commit 60ddee08a1
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -15,6 +15,17 @@ Turn a simple Markdown document into an elegant resume.
php ./build/build.php --source sample.md
php ./build/build.php --source sample.md --pdf
## Options
If you want to edit your markdown resume in your editor while watching it
update in your browser, run this command:
watch php ./build/build.php -s sample.md -r
This makes the build script run periodically, and html document will refresh
every two seconds. Open the `./ouput/sample.html` file in your browser, and
then just save your markdown document when you want to see a fresh preview.
## Development
Markdown is limited to basic html markup. Follow the `resume/sample.md` file