Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates based on onboarding experience #320

Merged
merged 6 commits into from
May 24, 2024

Conversation

esuomi
Copy link
Collaborator

@esuomi esuomi commented May 24, 2024

A few minor things I noticed while trying to get uttu (and enki) to run properly, plus a general formatting pass of the whole README to make it consistent with added hints in code blocks to allow for viewers to render the snippets with syntax highlighting.

fixes #316
closes #319

testower and others added 4 commits May 23, 2024 21:58
…on AArch64 Macs when Rosetta2 is not used

If run in a shell which is configured to not use Rosetta2 automatically the plain docker run command fails because an image with same platform (aarch64) is not available. Explicitly setting the --platform parameter gets around this permanently.
… widths and whitespaces/newlines uniform etc.
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@testower testower merged commit 653b4ba into entur:master May 24, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation / onboarding
2 participants