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

Commit ee3c36a

Browse files
Updated README and USAGE
1 parent 4fdc6f2 commit ee3c36a

File tree

2 files changed

+57
-4
lines changed

2 files changed

+57
-4
lines changed

README.md

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,39 @@ Once Cygwin is installed it can be further configured by running:
7070

7171
and choosing packages to install/remove.
7272

73+
Installation troubleshoting
74+
---
75+
76+
* **Cygwin installation takes forever/fails** - some packages are available
77+
only on mirrors.kernel.org. For some reason the site has sometimes problems
78+
with FTP transfer and Cygwin Setup cannot either connect or has very slow
79+
transfer. You can try to restart script (it saves your progress so you won't
80+
have to install the same thing twice), or try to rerun it some time later.
81+
* **Gradle installation freezes even though all files are extracted** - Gradle
82+
actually hav > 10k files to extract, many of them so small that you might not
83+
notice, that they are still being extracted when you check directory size
84+
only. Wait a litte bit more.
85+
* **Editors (Atom, Light Table, Sublime Text) fail to extract** - for some
86+
reason, uknown to me, even though file is downloaded on first try script
87+
might show error that it cannot find it and thus is unable to extract files.
88+
I can only guess that it is some sort of race condition or other error on my
89+
part resulting in call for extraction just before filesystem knows that
90+
downloaded file arrived. Rerunning script helps (one might need to remove
91+
`symlinks.mrk` file to try to create symlinks again).
92+
93+
Portability
94+
---
95+
96+
Basically whole package was build with portability in mind. OTTOOMH only
97+
`set_PATH_depottools.ps1` modifies `PATH` environment vairable and so it would
98+
require running (and cleaning after) on every system.
99+
100+
I have noticed though that when package is synchronized with e.g. Copy.com
101+
software, symlinks (NTFS's junctions) get broken and functionality depending on
102+
them stops working. Therefore one needs to choose method of transfering the
103+
whole installation that would preserve them if he want to make use of its
104+
portability.
105+
73106
Usage
74107
---
75108

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

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

84118
License
85119
---
86120

87-
Scripts and configs are published with Apache 2.0 license. As such anyone can
88-
use them and modify to their needs.
121+
Scripts and my own configs are published with Apache 2.0 license. As such anyone
122+
can use them and modify to their needs. Configs being modifications are licensed
123+
like their originals.
89124

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

162+
[GYP](https://code.google.com/p/gyp/) - Chromium's builder.
163+
127164
### Java JRE and JDK
128165

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

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

171+
[SBT](http://www.scala-sbt.org/) - Simple Build Tool written in Scala.
172+
134173
### Clojure
135174

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

166205
[Sublime Text](http://www.sublimetext.com/3) - Sublime Text 3 text editor.
206+
207+
### Apt-Cyg
208+
209+
[apt-cyg](https://github.com/transcode-open/apt-cyg) - apt-get like manager for
210+
Cygwin.
211+
212+
### CLOC
213+
214+
[CLOC](http://cloc.sourceforge.net/) - Count Lines of Code.

USAGE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ Boost 1.55
101101

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

104+
Chromium's libchrome and minichromium
105+
---
106+
107+
Run `/opt/install_libchrome.sh` or `/opt/install_mini_chromium.sh` respectively.
108+
104109
Text editor plugins
105110
---
106111

@@ -115,5 +120,5 @@ respectively.
115120
Known problems
116121
===
117122

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

0 commit comments

Comments
 (0)