Skip to content

Commit 8f10f6d

Browse files
committed
(docs): Update documentation on the repository structure
1 parent a0fe47e commit 8f10f6d

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/hacking.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,24 @@
1010

1111
*Note*: The structure below is Work In Progress.
1212

13+
* `/app` - applications
1314
* `/blocks` - filesystem root for `BLOCK` wordset implementations
1415
* `/bootdict` - Bootstrap dictionary, Flat Assembler sources
1516
* `/tc` - Forth VM threaded code
1617
* `/x86` - native x86 code
1718
* `/x86-dtc` - native x86 code, DTC specifics
1819
* `/x86-itc` - native x86 code, ITC specifics
20+
* `/x86-wordlist` - wordlist structures, x86 and Forth VM threaded code
1921
* `bootdict-x86.asm` - main module for x86
2022
* `/build` - build artifacts and temporary files
21-
* `/contrib`
22-
* `/*` - contributions, Forth
23-
* `*.4th`
2423
* `/docs` - system documentation
24+
* `/adr` - Architecture Decision Records
2525
* `/docker` - definitions for Dockerized build environments
2626
* `/lib` - libraries
2727
* `/product`
28-
* `ikforth-base-x86` - basic interactive system configuration, Forth
29-
* `ikforth-dev-x86` - developer's interactive configuration, Forth
30-
* `/src`
31-
* `/lincon` - LINux CONstants dynamic library, C sources
32-
* `/loader` - Loader for dictionaries, C/C++ sources
28+
* `/ikforth-base-x86` - basic interactive system configuration, Forth
29+
* `/ikforth-dev-x86` - developer's interactive configuration, Forth
30+
* `/ikforth-dist` - release distribution
3331
* `/sysdict` - system dictionary, Forth
3432
* `/term` - terminal integration, Forth
3533
* `/x86` - x86-specific primitives, Forth
@@ -40,3 +38,7 @@
4038
* `/*` - tests, Forth
4139
* `/forth2012-test-suite` - Gerry Jackson's Test programs for Forth 2012 and ANS Forth
4240
* `*.4th`
41+
* `/tools`
42+
* `/linconst-extract` - tool for extracting constants from Linux headers, C sources
43+
* `/loader` - Loader for dictionaries, C/C++ sources
44+
* `/winconst-extract` - tool for extracting constants from Windows headers, C sources

0 commit comments

Comments
 (0)