Skip to content

Commit e4898ff

Browse files
committed
Adding clear steps to build from repository source
1 parent 81f958c commit e4898ff

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

HACKING.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,42 @@ HACKING
22
=======
33

44
This file is for those who want s to hask the cutting-edge Sagittarius
5-
sources from the Git repository. If you just want to compile
6-
from the distribution, you don't need to read any further.
5+
sources from the Git repository. If you just want to compile from the
6+
distribution, you don't need to read any further.
7+
8+
Prerequisites
9+
-------------
10+
11+
To build the cutting-edge Sagittarius, you need applications blow as
12+
extra to the usual build:
13+
14+
- Latest release of Sagittarius
15+
- Git
16+
17+
18+
Steps
19+
-----
20+
21+
1. Checkout repository
22+
```shell
23+
git clone https://github.com/ktakashi/sagittarius-scheme
24+
```
25+
2. Generate code
26+
For POSIX
27+
```shell
28+
./dist.sh gen
29+
```
30+
For Windows
31+
```bat
32+
dist.bat gen
33+
```
34+
3. The usual build
35+
36+
More details are documented below.
37+
38+
If your PATH doesn't contain the latest Sagittarius, see `Generate
39+
code` section how to specify the binary path.
40+
741

842
How to check out from the repository
943
------------------------------------
@@ -90,6 +124,9 @@ To clean the generated code, you need to execute following command;
90124
./dist.sh clean
91125
```
92126

127+
The clean command is not needed in a usual case. Use it only when
128+
you need to rebuild data files, such as Unicode files.
129+
93130
#### Using local TZ database and Unicode files
94131

95132
If you want to use local TZ database file or Unicode files, you can

0 commit comments

Comments
 (0)