Skip to content

Commit fb60a74

Browse files
committed
Improving HACKING.md (Closes #332)
1 parent 1838586 commit fb60a74

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

HACKING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Prerequisites
99
-------------
1010

1111
To build the cutting-edge Sagittarius, you need applications blow as
12-
extra to the usual build:
12+
extra to the usual build described in [README.md](README.md):
1313

14-
- Latest release of Sagittarius
15-
- Git
14+
- Latest release of Sagittarius: [Download](https://github.com/ktakashi/sagittarius-scheme/releases)
15+
- Git: [How to install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
1616

1717

1818
Steps
@@ -23,6 +23,8 @@ Steps
2323
git clone https://github.com/ktakashi/sagittarius-scheme
2424
```
2525
2. Generate code
26+
This step generates necessary C files from the stub files and Scheme files.
27+
It must be completed before running the build process, or the build will fail.
2628
For POSIX
2729
```shell
2830
./dist.sh gen
@@ -101,7 +103,8 @@ To generate code you need to execute following commands;
101103
./dist.sh html
102104
```
103105

104-
Or this command does the same;
106+
Alternatively, you can run the following command to execute all the
107+
above steps:
105108

106109
```shell
107110
./dist.sh gen
@@ -111,6 +114,8 @@ These commands generate C files from stub files and Scheme files
111114
respectively. This must be run *before* CMake command otherwise CMake
112115
process will fail.
113116

117+
#### Using different Sagittarius executable
118+
114119
If you set the path to Sagittarius executable to the environment
115120
variable `SASH` with, then `dist.sh` will use that executable file.
116121

0 commit comments

Comments
 (0)