mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2025-12-27 07:04:04 -05:00
Documentation improvements (#7672)
This PR includes various documentation improvements: - Fix grammar in README.md introduction - Update Node.js version references to consistently indicate 'Node.js 20 or higher' - Enhance macOS installation and setup guide with detailed instructions - Fix broken link in API.md - Fix formatting inconsistencies in WhatIsCompilerExplorer.md 🤖 Generated with [Claude Code](https://claude.ai/code) --------- Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -5,9 +5,9 @@
|
||||
|
||||
# Compiler Explorer
|
||||
|
||||
Is an interactive compiler exploration website. Edit code in C, C++, C#, F#, Rust, Go, D, Haskell, Swift, Pascal,
|
||||
Compiler Explorer is an interactive compiler exploration website. Edit code in C, C++, C#, F#, Rust, Go, D, Haskell, Swift, Pascal,
|
||||
[ispc](https://ispc.github.io/), Python, Java, or any of the other
|
||||
[30+ supported languages](https://godbolt.org/api/languages) components, and see how that code looks after being
|
||||
[30+ supported languages](https://godbolt.org/api/languages), and see how that code looks after being
|
||||
compiled in real time.
|
||||
|
||||
[Bug Report](https://github.com/compiler-explorer/compiler-explorer/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBUG%5D%3A+)
|
||||
@@ -75,7 +75,7 @@ Assuming you have a compatible version of `node` installed, on Linux simply runn
|
||||
running with an Explorer running on port 10240 on your local machine:
|
||||
[http://localhost:10240/](http://localhost:10240/). If this doesn't work for you, please contact us, as we consider it
|
||||
important you can quickly and easily get running. Currently, **Compiler Explorer** requires
|
||||
[`node` 22](CONTRIBUTING.md#node-version) installed, either on the path or at `NODE_DIR` (an environment variable or
|
||||
[`node` 20 or higher](CONTRIBUTING.md#node-version) installed, either on the path or at `NODE_DIR` (an environment variable or
|
||||
`make` parameter).
|
||||
|
||||
Running with `make EXTRA_ARGS='--language LANG'` will allow you to load `LANG` exclusively, where `LANG` is one for the
|
||||
|
||||
@@ -183,8 +183,8 @@ structure:
|
||||
```
|
||||
|
||||
The name property corresponds to the `<formatter>` when requesting `POST /api/format/<formatter>`. The `type` key in the
|
||||
JSON request corresponds to one of the `formatters.<key>.type` found in
|
||||
[compiler-explorer.amazon.properties:43](../etc/config/compiler-explorer.amazon.properties#L43)
|
||||
JSON request corresponds to one of the `formatters.<key>.type` found in the compiler-explorer configuration properties
|
||||
(see [Configuration.md](Configuration.md) for more details)
|
||||
|
||||
### `POST /api/format/<formatter>` - perform a formatter run
|
||||
|
||||
|
||||
@@ -1,6 +1,22 @@
|
||||
# Running on MacOS
|
||||
|
||||
## With default XCode installation
|
||||
## Prerequisites
|
||||
|
||||
1. **Node.js**: Ensure you have Node.js 20 or higher installed
|
||||
- Installation options include Homebrew or the official installer from [nodejs.org](https://nodejs.org/)
|
||||
|
||||
2. **Xcode Command Line Tools**:
|
||||
- Required for compilers and build tools
|
||||
- Can be installed via `xcode-select --install`
|
||||
- Be sure to accept the Xcode EULA
|
||||
|
||||
## Required Configuration Changes
|
||||
|
||||
* Be sure to have accepted the XCode EULA
|
||||
* Change in `etc/config/compiler-explorer.defaults.properties` the line `objdumperType=default` to `objdumperType=llvm`
|
||||
* This ensures compatibility with macOS's LLVM-based toolchain
|
||||
|
||||
## Notes
|
||||
|
||||
* By default, Apple Clang will be available as a compiler
|
||||
* For configuration details, see [Configuration.md](Configuration.md)
|
||||
* Follow the standard setup instructions in the main [README.md](../README.md)
|
||||
|
||||
@@ -16,7 +16,7 @@ and `esi`, and result left in `eax`:
|
||||
01fe89f0c3
|
||||
```
|
||||
|
||||
Machine code may be what the computer needs, it is not a convenient representation for humans. Instead, _assembly_ is
|
||||
Machine code may be what the computer needs, but it is not a convenient representation for humans. Instead, _assembly_ is
|
||||
commonly used, a (somewhat readable) text representation of the machine code. The encoding is bidirectional: humans can
|
||||
write assembly and have it encoded as machine code with a program called an _assembler_, and machine code can be turned
|
||||
into assembly with a _disassembler_.
|
||||
@@ -39,7 +39,7 @@ int add(int x, int y) {
|
||||
```
|
||||
|
||||
A compiler turns this source into machine code (for example, GCC). The compiler parses and understands the C language,
|
||||
turning the programmer's intention into the nitty-gritties of the target CPU's machine code. Compilers can also also
|
||||
turning the programmer's intention into the nitty-gritties of the target CPU's machine code. Compilers can also
|
||||
perform _optimizations_ which can significantly improve the code performance over a naive transliteration.
|
||||
|
||||
For example, passing GCC the C source above and asking it to optimize produces the following machine code/assembly:
|
||||
|
||||
Reference in New Issue
Block a user