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

Add README.md #14

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add README.md #14

wants to merge 4 commits into from

Conversation

emeb
Copy link

@emeb emeb commented Sep 19, 2024

A quick-n-dirty README.md file based on some conversation on the 1bitsquared discord.

@dragonmux dragonmux added this to the v1.0 milestone Sep 19, 2024
@dragonmux dragonmux added Documentation Project documentation Enhancement General project improvement labels Sep 19, 2024
Copy link
Member

@dragonmux dragonmux left a comment

Choose a reason for hiding this comment

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

Only seen the one thing that could do with tweaking and it's only because of some debugging we did today. Otherwise this looks good to merge as-is.


> [!NOTE]
> Some newer versions of meson have changed the syntax of the build script which will cause errors during this step. You may need to modify the script
as follows: Find the line in the file `meson.build` with `'b_debug=if-release'` and change it to `'debug=false'` and try rerunning the setup command.
Copy link
Member

Choose a reason for hiding this comment

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

Some further debugging turned up that the option is actually b_ndebug - so, we'll make a commit changing the b_debug line to b_ndebug=if-release which works and is fine. Till we do that, the advice should be to correct the option name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Project documentation Enhancement General project improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants