Skip to content

Commit 768e8cf

Browse files
swolchokfacebook-github-bot
authored andcommitted
Update README.md regarding partial Windows support
Summary: This should summarize and clarify fastmod's position on Windows support, as discussed in #1 . Reviewed By: ColinCampbell Differential Revision: D7955036 fbshipit-source-id: f8f8f2a1b2a3974ae754fef97cacab00f15074d9
1 parent 2502ae1 commit 768e8cf

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,20 @@ own parallel directory traversal internally, so doing `find ... |
5757
xargs fastmod ...` may be much slower than using `fastmod` by itself.
5858

5959
## Requirements
60-
`fastmod` is supported on macOS and Linux.
60+
61+
`fastmod` is primarily supported on macOS and Linux.
62+
63+
`fastmod` has also been reported to work reasonably well on
64+
Windows. The major portability concerns are 1) the use of `$EDITOR`
65+
with a fallback and 2) the console UI, which is descended from
66+
`codemod`'s ncurses-based text coloring & screen clearing
67+
code. Windows-specific issues and PRs will be considered as long as
68+
they aren't too invasive. For example, if something doesn't work on
69+
Windows because a Linux/Mac-specific API was used instead of
70+
equivalent POSIX or Rust standard library calls, we would be happy to
71+
fix that. On the other hand, we would like to avoid taking a direct
72+
`winapi` dependency or substantially increasing the size of our
73+
dependency graph for Windows-only enhancements.
6174

6275
## Building `fastmod`
6376

0 commit comments

Comments
 (0)