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

Flesh out a basic README for Alloy #89

Merged
merged 1 commit into from
Oct 9, 2023

Conversation

jacob-hughes
Copy link
Collaborator

This is just a start, it contains the basic build steps and a (hopefully) motivating example. This still needs to explain the intricacies of finalisers.

README.md Outdated

## Building Documentation
This tends to work well in practice, however, it comes with an important caveat:
you must not hide references from the type system. For example, data structures
Copy link
Member

Choose a reason for hiding this comment

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

s/from the type system/from the GC/

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed here
1eb9bba

README.md Show resolved Hide resolved
@jacob-hughes
Copy link
Collaborator Author

Can I squash this?

@ltratt
Copy link
Member

ltratt commented Oct 9, 2023

Please squash.

@jacob-hughes
Copy link
Collaborator Author

Squashed

@ltratt
Copy link
Member

ltratt commented Oct 9, 2023

bors r+

@bors
Copy link

bors bot commented Oct 9, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit ee5924c into softdevteam:master Oct 9, 2023
9 of 12 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.

2 participants