aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRon Yorston <rmy@pobox.com>2015-01-07 10:33:03 +0000
committerRon Yorston <rmy@pobox.com>2015-01-07 10:33:03 +0000
commit8ec94b6f617dc1314221f0ebf6b01467c62950e3 (patch)
tree4e56a810f5f7feb2755939811c886e05c8494ffb /README.md
parent17102d117aa6afa1b6d261fb6f49cf176921a681 (diff)
downloadbusybox-w32-8ec94b6f617dc1314221f0ebf6b01467c62950e3.tar.gz
busybox-w32-8ec94b6f617dc1314221f0ebf6b01467c62950e3.tar.bz2
busybox-w32-8ec94b6f617dc1314221f0ebf6b01467c62950e3.zip
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..1ef735a74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
1### Status
2
3This port is used in production at Tigress. Things may work for you, or may not. Things may never work because of huge differences between Linux and Windows. Or things may work in future, if you report the problem to https://github.com/rmyorston/busybox-w32.
4
5### Building
6
7You need a MinGW compiler and a POSIX environment (so that `make menuconfig` works). I cross compile from Linux, but MSYS or Cygwin should be OK.
8
9To start, run `make mingw32_defconfig`. You can then customize your build with `make menuconfig`.
10
11In particular you may need to adjust the compiler by going to Busybox Settings -> Build Options -> Cross Compiler Prefix
12
13Then just `make`.
14
15### Limitations
16
17 - Use forward slashes in paths: Windows doesn't mind and the shell will be happier.
18 - Don't do wild things with Windows drive or UNC notation.
19 - tar doesn't support seamless compression/decompression: use a pipeline to a compressor/decompressor.