From 768e8cf02a0a69b3385f2de6c013bf4611022389 Mon Sep 17 00:00:00 2001 From: Scott Wolchok Date: Thu, 10 May 2018 15:57:36 -0700 Subject: [PATCH] Update README.md regarding partial Windows support Summary: This should summarize and clarify fastmod's position on Windows support, as discussed in https://github.com/facebookincubator/fastmod/issues/1 . Reviewed By: ColinCampbell Differential Revision: D7955036 fbshipit-source-id: f8f8f2a1b2a3974ae754fef97cacab00f15074d9 --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc894d8..fb329d7 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,20 @@ own parallel directory traversal internally, so doing `find ... | xargs fastmod ...` may be much slower than using `fastmod` by itself. ## Requirements -`fastmod` is supported on macOS and Linux. + +`fastmod` is primarily supported on macOS and Linux. + +`fastmod` has also been reported to work reasonably well on +Windows. The major portability concerns are 1) the use of `$EDITOR` +with a fallback and 2) the console UI, which is descended from +`codemod`'s ncurses-based text coloring & screen clearing +code. Windows-specific issues and PRs will be considered as long as +they aren't too invasive. For example, if something doesn't work on +Windows because a Linux/Mac-specific API was used instead of +equivalent POSIX or Rust standard library calls, we would be happy to +fix that. On the other hand, we would like to avoid taking a direct +`winapi` dependency or substantially increasing the size of our +dependency graph for Windows-only enhancements. ## Building `fastmod`