diff options
author | Ron Yorston <rmy@pobox.com> | 2015-01-07 10:33:03 +0000 |
---|---|---|
committer | Ron Yorston <rmy@pobox.com> | 2015-01-07 10:33:03 +0000 |
commit | 8ec94b6f617dc1314221f0ebf6b01467c62950e3 (patch) | |
tree | 4e56a810f5f7feb2755939811c886e05c8494ffb | |
parent | 17102d117aa6afa1b6d261fb6f49cf176921a681 (diff) | |
download | busybox-w32-8ec94b6f617dc1314221f0ebf6b01467c62950e3.tar.gz busybox-w32-8ec94b6f617dc1314221f0ebf6b01467c62950e3.tar.bz2 busybox-w32-8ec94b6f617dc1314221f0ebf6b01467c62950e3.zip |
Update README
-rw-r--r-- | README | 2 | ||||
-rw-r--r-- | README.md | 19 | ||||
-rw-r--r-- | README.win32 | 32 |
3 files changed, 20 insertions, 33 deletions
@@ -1,4 +1,4 @@ | |||
1 | Please see README.win32 for Windows-specific info. | 1 | Please see README.md for Windows-specific info. |
2 | Please see the LICENSE file for details on copying and usage. | 2 | Please see the LICENSE file for details on copying and usage. |
3 | Please refer to the INSTALL file for instructions on how to build. | 3 | Please refer to the INSTALL file for instructions on how to build. |
4 | 4 | ||
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 | |||
3 | This 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 | |||
7 | You 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 | |||
9 | To start, run `make mingw32_defconfig`. You can then customize your build with `make menuconfig`. | ||
10 | |||
11 | In particular you may need to adjust the compiler by going to Busybox Settings -> Build Options -> Cross Compiler Prefix | ||
12 | |||
13 | Then 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. | ||
diff --git a/README.win32 b/README.win32 deleted file mode 100644 index 9e9c8f39f..000000000 --- a/README.win32 +++ /dev/null | |||
@@ -1,32 +0,0 @@ | |||
1 | Status | ||
2 | ====== | ||
3 | |||
4 | I would consider this port experimental. Things may work, or may not. | ||
5 | Things may never work because of huge differences between Linux and | ||
6 | Windows. Or things may work in future, if you report the faults to | ||
7 | https://github.com/rmyorston/busybox-w32, especially with patches. | ||
8 | |||
9 | Building | ||
10 | ======== | ||
11 | |||
12 | You need MinGW compiler and a POSIX environment (so that "make | ||
13 | menuconfig" works). I cross compile from Linux, but MSYS or Cygwin | ||
14 | should be OK. | ||
15 | |||
16 | To start, run "make mingw32_defconfig". You can then customize your | ||
17 | build with "make menuconfig". | ||
18 | |||
19 | In particular you may need to adjust the compiler by going to Busybox | ||
20 | Settings -> Build Options -> Cross Compiler Prefix | ||
21 | |||
22 | Then just "make". | ||
23 | |||
24 | Attempts to make it work with MS Visual Studio are appreciated. You | ||
25 | can start with porting kconfig ;-) | ||
26 | |||
27 | Limitation | ||
28 | ========== | ||
29 | |||
30 | - Use forward slashes. Backslash support is very limited. | ||
31 | - Do not do wild things with Windows drive notation, like archiving a | ||
32 | whole drive. If you want it, tell us, preferably with patches. | ||