leetNightshade
/
FileWatcher
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixed the formatting of the readme.md file.

This commit is contained in:
Brian 2013-12-20 20:19:51 -07:00
parent f6eb064ce4
commit f96effd6fb
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -5,18 +5,21 @@ FileWatcher is currently a Windows only C# and IronPython driven program for run
The program is still in Alpha, though it's basically useable. I still have some bugs to work out, and A LOT of features to work out. I also plan on having some premade scripts to make using it as easy as possible. I have never written a plugin system before (well, the current implementation isn't one, but I'd like to try), so bear with me, and maybe send me some feedback on how I can improve the program.
Requirements:
+IronPython 2.7.3
Requirements
-----------
*IronPython 2.7.3
Notes:
+FileWatcher runs in the background, it's a taskbar application. So when you close the windows, the program is still running. To exit you have to open up the menu File>Exit, or right click on the icon in the taskbar and hit Exit.
+Play/Stop buttons do not yet do anything.
+There are currently no hot keys, only keyboard shortcuts when the program is open. If you have a request for specific types of hotkeys, let me know.
+There are some issues with running at startup that may not have been resolved in this version. I need to fix this.
Notes
-----------
*FileWatcher runs in the background, it's a taskbar application. So when you close the windows, the program is still running. To exit you have to open up the menu File>Exit, or right click on the icon in the taskbar and hit Exit.
*Play/Stop buttons do not yet do anything.
*There are currently no hot keys, only keyboard shortcuts when the program is open. If you have a request for specific types of hotkeys, let me know.
*There are some issues with running at startup that may not have been resolved in this version. I need to fix this.
Features:
+Script delay specifyable in units ms, s, m, and h. For instance, you can delay the script by "1s 500ms" or "1h 5m 25ms". This timer can be reset when a file is updated, or continue to count down when the first file was updated.
+Script file is monitored for changes and can be reloaded at the press of a button.
+Script Shortcut button for opening your favorite text editor and quickly updating the script.
+If there's a problem with the script you'll be told what the basic issue is and where it is in the log window, or by hovering over the warning icon in the File Group where the script was loaded.
+Create File Groups to monitor multiple directories, each group uses it's own script. (Currently you can't enable/disable groups, they're automatically active as long as everything is setup correctly)
Features
-----------
*Script delay specifyable in units ms, s, m, and h. For instance, you can delay the script by "1s 500ms" or "1h 5m 25ms". This timer can be reset when a file is updated, or continue to count down when the first file was updated.
*Script file is monitored for changes and can be reloaded at the press of a button.
*Script Shortcut button for opening your favorite text editor and quickly updating the script.
*If there's a problem with the script you'll be told what the basic issue is and where it is in the log window, or by hovering over the warning icon in the File Group where the script was loaded.
*Create File Groups to monitor multiple directories, each group uses it's own script. (Currently you can't enable/disable groups, they're automatically active as long as everything is setup correctly)