Skip to content

Commit d8884d8

Browse files
committed
Update README.md with usage example
Change-Id: Iabb73111e1a5736d9b0b58d95fd2578adc8f9bda
1 parent a350a5d commit d8884d8

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@ Alternatively to just compile the `gsh` binary you can do:
3232

3333
$ gprbuild -p -P posix_shell
3434

35+
Example of Usage
36+
----------------
37+
38+
Currently the main goal of the project is to speed up builds of
39+
[GNU](https://www.gnu.org) projects on Windows platform. As the project is
40+
still not complete you still need a [Cygwin](http://www.cygwin.com)
41+
installation for the tools not provided by GSH. The only requirement is that
42+
the build should be done in a path for which Cygwin path maps directly to
43+
a Windows path. For example if you do your build in c:/MyBuilds then in Cygwin
44+
the path should map to /MyBuilds.
45+
46+
An example of build sequence that does not destroy your current Cygwin
47+
environment:
48+
49+
$ (export PATH=$GSH_INSTALL_DIR/bin:$PATH;
50+
export SHELL=$GSH_INSTALL_DIR/bin/gsh;
51+
export CONFIG_SHELL=$GSH_INSTALL_DIR/bin/gsh;
52+
$CONFIG_SHELL/configure --prefix=/myinstall_dir
53+
make)
54+
55+
3556
License
3657
-------
3758

0 commit comments

Comments
 (0)