Skip to content

Commit

Permalink
(docs): Update documentation on the repository structure
Browse files Browse the repository at this point in the history
  • Loading branch information
ikysil committed Jan 22, 2021
1 parent a0fe47e commit 8f10f6d
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/hacking.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,24 @@

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

* `/app` - applications
* `/blocks` - filesystem root for `BLOCK` wordset implementations
* `/bootdict` - Bootstrap dictionary, Flat Assembler sources
* `/tc` - Forth VM threaded code
* `/x86` - native x86 code
* `/x86-dtc` - native x86 code, DTC specifics
* `/x86-itc` - native x86 code, ITC specifics
* `/x86-wordlist` - wordlist structures, x86 and Forth VM threaded code
* `bootdict-x86.asm` - main module for x86
* `/build` - build artifacts and temporary files
* `/contrib`
* `/*` - contributions, Forth
* `*.4th`
* `/docs` - system documentation
* `/adr` - Architecture Decision Records
* `/docker` - definitions for Dockerized build environments
* `/lib` - libraries
* `/product`
* `ikforth-base-x86` - basic interactive system configuration, Forth
* `ikforth-dev-x86` - developer's interactive configuration, Forth
* `/src`
* `/lincon` - LINux CONstants dynamic library, C sources
* `/loader` - Loader for dictionaries, C/C++ sources
* `/ikforth-base-x86` - basic interactive system configuration, Forth
* `/ikforth-dev-x86` - developer's interactive configuration, Forth
* `/ikforth-dist` - release distribution
* `/sysdict` - system dictionary, Forth
* `/term` - terminal integration, Forth
* `/x86` - x86-specific primitives, Forth
Expand All @@ -40,3 +38,7 @@
* `/*` - tests, Forth
* `/forth2012-test-suite` - Gerry Jackson's Test programs for Forth 2012 and ANS Forth
* `*.4th`
* `/tools`
* `/linconst-extract` - tool for extracting constants from Linux headers, C sources
* `/loader` - Loader for dictionaries, C/C++ sources
* `/winconst-extract` - tool for extracting constants from Windows headers, C sources

0 comments on commit 8f10f6d

Please sign in to comment.