Skip to content

New readme #508

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

Merged
merged 6 commits into from
Jul 25, 2022
Merged

New readme #508

merged 6 commits into from
Jul 25, 2022

Conversation

aspeddro
Copy link
Contributor

No description provided.

@zth
Copy link
Collaborator

zth commented Jul 24, 2022

@aspeddro Could you write what the motivation for this is? Not saying it's bad, it's probably great, but I'd like to know what the underlying thought behind it is.

@aspeddro
Copy link
Contributor Author

Add link to:

  • Changelog
  • How to Contribute
  • License

Also, organize the topics, command and settings in table. I think the table summarizing the settings and commands is easier to find and visualize

Copy link
Collaborator

@zth zth left a comment

Choose a reason for hiding this comment

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

Looking good! One thing I'd like changed though.

Reminder - we should update the features list, it's a bit inaccurate as of now.

README.md Outdated
#### `> Open the compiled JS file for this implementation file.`
| Setting | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Autostarting ReScript builds | If there's no ReScript build running already in the opened project, the extension will prompt you and ask if you want to start a build automatically. You can turn off this automatic prompt via the setting `rescript.settings.askToStartBuild`. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this title is accurate, since the setting is just about the prompt, not actually autostarting a build. Maybe change it to "Prompt to start build" or something like that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done 7086e83

@aspeddro
Copy link
Contributor Author

Synced with master

Copy link
Collaborator

@zth zth left a comment

Choose a reason for hiding this comment

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

Looks good from my side! @cristianoc ?

@zth
Copy link
Collaborator

zth commented Jul 25, 2022

@aspeddro could you do one final sync with current master for the readme, with the new things that have been added? Merging right away after that.

@aspeddro
Copy link
Contributor Author

Done

@zth zth merged commit 39a2270 into rescript-lang:master Jul 25, 2022
@aspeddro aspeddro deleted the new-readme branch December 19, 2022 17:26
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