Skip to content

Commit

Permalink
Update README.md regarding partial Windows support
Browse files Browse the repository at this point in the history
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
  • Loading branch information
swolchok authored and facebook-github-bot committed May 10, 2018
1 parent 2502ae1 commit 768e8cf
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

0 comments on commit 768e8cf

Please sign in to comment.