Skip to content

Commit 80f07d0

Browse files
Automate installing Haxe and building the project
1 parent dcea134 commit 80f07d0

File tree

5 files changed

+45
-925
lines changed

5 files changed

+45
-925
lines changed

.gitignore

+5-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
node_modules
1+
bin/
2+
node_modules/
3+
4+
git-cache-http-server-*.tgz
5+
package-lock.json

README.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,34 @@ systemctl daemon-reload
5858
systemctl start git-cache-http-server
5959
```
6060

61-
# Working on the sources
61+
# Working with the Haxe sources
6262

63-
This is only needed if you want to change the Haxe source code in `src/`.
63+
To modify the code or use the latest features and fixes, it is necessary to
64+
build the Haxe sources in `src/`.
6465

65-
Requirements: [Haxe](https://haxe.org) (`haxe` and `haxelib`). If you prefer
66-
to manage the build dependencies manually, check out [`build.hxml`](build.hxml)
67-
for the required libraries.
66+
The process of installing Haxe, any additional dependencies, and building the
67+
project has been automated with the use of a `prepare` script, and should work
68+
transparently with the usual npm commands. The resulting JS script will be
69+
placed in `bin/`.
6870

6971
```
70-
haxelib newrepo
71-
haxelib install build.hxml
72-
haxe build.hxml
72+
# install development dependencies and build
73+
npm install
74+
75+
# install the built package globally
76+
npm install --global
77+
```
78+
79+
Additionally, the following scripts are available should there be a need to
80+
update the Haxe dependencies or quickly rebuild the Haxe code alone:
81+
82+
```
83+
npm run installHaxelibs
84+
npm run build
7385
```
7486

75-
And in order to use the locally modified version: `npm link` (this changes the
76-
global NPM space).
87+
Note: after upgrading it might be necessary to purge old `.haxelib` and
88+
`node_modules` directories, as well any remaining of old installations.
7789

7890
# Implementation
7991

0 commit comments

Comments
 (0)