Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Commit

Permalink
Updated README and USAGE
Browse files Browse the repository at this point in the history
  • Loading branch information
MateuszKubuszok committed May 20, 2015
1 parent 4fdc6f2 commit ee3c36a
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 4 deletions.
54 changes: 51 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,39 @@ Once Cygwin is installed it can be further configured by running:

and choosing packages to install/remove.

Installation troubleshoting
---

* **Cygwin installation takes forever/fails** - some packages are available
only on mirrors.kernel.org. For some reason the site has sometimes problems
with FTP transfer and Cygwin Setup cannot either connect or has very slow
transfer. You can try to restart script (it saves your progress so you won't
have to install the same thing twice), or try to rerun it some time later.
* **Gradle installation freezes even though all files are extracted** - Gradle
actually hav > 10k files to extract, many of them so small that you might not
notice, that they are still being extracted when you check directory size
only. Wait a litte bit more.
* **Editors (Atom, Light Table, Sublime Text) fail to extract** - for some
reason, uknown to me, even though file is downloaded on first try script
might show error that it cannot find it and thus is unable to extract files.
I can only guess that it is some sort of race condition or other error on my
part resulting in call for extraction just before filesystem knows that
downloaded file arrived. Rerunning script helps (one might need to remove
`symlinks.mrk` file to try to create symlinks again).

Portability
---

Basically whole package was build with portability in mind. OTTOOMH only
`set_PATH_depottools.ps1` modifies `PATH` environment vairable and so it would
require running (and cleaning after) on every system.

I have noticed though that when package is synchronized with e.g. Copy.com
software, symlinks (NTFS's junctions) get broken and functionality depending on
them stops working. Therefore one needs to choose method of transfering the
whole installation that would preserve them if he want to make use of its
portability.

Usage
---

Expand All @@ -79,13 +112,15 @@ Details on how to use of added features and programs can be found
Libusb
---

File can be found on [sourceforge](http://sourceforge.net/projects/libusb-win32/files/latest/download).
If needed file can be found on
[sourceforge](http://sourceforge.net/projects/libusb-win32/files/latest/download).

License
---

Scripts and configs are published with Apache 2.0 license. As such anyone can
use them and modify to their needs.
Scripts and my own configs are published with Apache 2.0 license. As such anyone
can use them and modify to their needs. Configs being modifications are licensed
like their originals.

Disclaimer
---
Expand Down Expand Up @@ -124,13 +159,17 @@ package management in a apt-get like manner.
[depot_tools](http://www.chromium.org/developers/how-tos/depottools) - scripts
useful when working with Google code.

[GYP](https://code.google.com/p/gyp/) - Chromium's builder.

### Java JRE and JDK

[Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) -
Oracle's Java platform and development kit.

[Gradle](http://www.gradle.org/downloads) - build system (mainly) for Java.

[SBT](http://www.scala-sbt.org/) - Simple Build Tool written in Scala.

### Clojure

[Clojure](http://clojure.org/) - Clojure programming language.
Expand Down Expand Up @@ -164,3 +203,12 @@ Oracle's Java platform and development kit.
### Sublime Text

[Sublime Text](http://www.sublimetext.com/3) - Sublime Text 3 text editor.

### Apt-Cyg

[apt-cyg](https://github.com/transcode-open/apt-cyg) - apt-get like manager for
Cygwin.

### CLOC

[CLOC](http://cloc.sourceforge.net/) - Count Lines of Code.
7 changes: 6 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ Boost 1.55

Run `/opt/install_boost.sh` to download, build and install Boost 1.55

Chromium's libchrome and minichromium
---

Run `/opt/install_libchrome.sh` or `/opt/install_mini_chromium.sh` respectively.

Text editor plugins
---

Expand All @@ -115,5 +120,5 @@ respectively.
Known problems
===

(Portable )Sublime Text crashes when you try try to run it from bash terminal.
(Portable) Sublime Text crashes when you try try to run it from bash terminal.
I don't know how to fix that (or even why it happens).

0 comments on commit ee3c36a

Please sign in to comment.