Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ $ ./makeright x

* The build will (attempt to) detect the OS-type and cpu-type. It will build binaries `lde` and `ldex` in `../`_`ostype.cputype`_ (with .o files in `../`_`ostype.cputype-x`_. For example, Linux on a 64-bit x86 will use `linux.x86_64`, while macOS 11 on a (new M1) Mac will use `darwin.aarch64`.
* If you prefer `gcc` over `clang`, you will need to edit the makefile fragment for your configuration (`makefile-ostype.cputype-x`) and comment out the line (with a #) that defines `CC` as `clang` and uncomment the line (delete the #) for the line that defines `CC` as `gcc`.
* If you want to do your own loadups to construct sysout files (see [the Medley repository](https://github.com/Interlisp/medley) for details), you also need the `ldeinit` binary. However, the `ldeinit` you get from the above steps is *not* functional. You have to run `./makeright init clean` followed by `./makeright init` to get a correct `ldeinit` binary.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrasing "the ldeinit you get from the above steps is not functional" could be confusing, as the preceding steps (e.g., ./makeright x) are described as building lde or ldex, not ldeinit. This might lead users to incorrectly assume that an ldeinit binary is an expected output of those standard build commands.

To improve clarity, consider rephrasing to emphasize that ldeinit requires a distinct build process separate from the standard ones mentioned earlier. The suggested change below aims to make this distinction clearer.

Suggested change
* If you want to do your own loadups to construct sysout files (see [the Medley repository](https://github.com/Interlisp/medley) for details), you also need the `ldeinit` binary. However, the `ldeinit` you get from the above steps is *not* functional. You have to run `./makeright init clean` followed by `./makeright init` to get a correct `ldeinit` binary.
* If you need the `ldeinit` binary (e.g., for custom loadups to construct sysout files see [the Medley repository](https://github.com/Interlisp/medley) for details), it requires a special build. The standard build commands (like `./makeright x`) do not produce a functional `ldeinit`. To build a correct `ldeinit` binary, run `./makeright init clean` and then `./makeright init`.

### Building with CMake
We provide a `CMakeLists.txt` which provides mostly matching build capabilities to the `make` setup.
Expand Down