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

Docs: Add key features for nim #333

Closed
wants to merge 5 commits into from
Closed

Conversation

ynfle
Copy link
Contributor

@ynfle ynfle commented Feb 26, 2022

Closes #270

@ynfle ynfle force-pushed the add-key-features branch 2 times, most recently from 749d409 to f334cd0 Compare February 26, 2022 23:29
@ynfle
Copy link
Contributor Author

ynfle commented Feb 26, 2022

The value of key_features.title that starts with Customizable Memory Manag... is 30 characters, but it must not exceed 25 characters

I'm not sure what to do about this configlet check, I can't think of anything else.

@ynfle ynfle requested review from ErikSchierboom and ee7 February 26, 2022 23:32
@ynfle
Copy link
Contributor Author

ynfle commented Feb 26, 2022

@AmjadHD I'd be interested to hear your opinion

@ErikSchierboom
Copy link
Member

@ynfle What about "Custom Memory Management"? That's 24 characters.

Copy link
Member

@ErikSchierboom ErikSchierboom left a comment

Choose a reason for hiding this comment

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

With one suggestion for the title.

Copy link
Member

@ee7 ee7 left a comment

Choose a reason for hiding this comment

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

Cool, thanks.

I think writing the list of key features is pretty hard for Nim - there's a lot to squeeze in.

config.json Outdated Show resolved Hide resolved
config.json Outdated Show resolved Hide resolved
config.json Outdated Show resolved Hide resolved
config.json Outdated Show resolved Hide resolved
config.json Outdated Show resolved Hide resolved
config.json Outdated Show resolved Hide resolved
config.json Outdated
},
{
"title": "Fast",
"content": "Compiles to C/C++/ObjC with no run time or virtual machine for blazing fast results.",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"content": "Compiles to C/C++/ObjC with no run time or virtual machine for blazing fast results.",
"content": "Compiles to C/C++/ObjC with no runtime or virtual machine for blazing fast results.",

Copy link
Member

Choose a reason for hiding this comment

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

There's a possible misreading of "with no runtime or virtual machine for blazing fast results" -> "with no blazing fast results" -> "it's slow". Also some potential confusion due to "with no virtual machine", since we have the Nim VM at compile time.

Maybe something like this?

"Compiles to a small, blazing-fast binary (no runtime or virtual machine overhead)".

I think it's better to mention "small binary" (which many people care about, even outside embedded - it's also an advantage over Go) than mentioning C++ and ObjC. But this wording does lose out on "compiles to C" (and JavaScript). Can we find a wording that conveys everything?

Copy link
Contributor Author

@ynfle ynfle Mar 1, 2022

Choose a reason for hiding this comment

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

How about

"Compiles using C/C++/JS to a small, blazing-fast binary (no runtime or virtual machine overhead)."

Copy link
Member

Choose a reason for hiding this comment

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

The problem is that compiling to JS isn't compiling to a binary :)

Copy link
Contributor Author

@ynfle ynfle Mar 6, 2022

Choose a reason for hiding this comment

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

How about this?

"Compiles using C/C++/Objc to a small, blazing-fast binary (no runtime or virtual machine overhead)."

I think we can leave out JS for now

EDIT

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bump

config.json Outdated Show resolved Hide resolved
@ynfle ynfle requested a review from ee7 March 19, 2022 18:59
ynfle and others added 4 commits March 19, 2022 21:04
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
@ynfle ynfle force-pushed the add-key-features branch from 09d1954 to 71896d9 Compare March 19, 2022 19:04
@ynfle
Copy link
Contributor Author

ynfle commented Apr 1, 2022

Bump

@ee7
Copy link
Member

ee7 commented Apr 7, 2022

Sorry for the delay. I'll try to review tomorrow.

@ee7
Copy link
Member

ee7 commented Apr 9, 2022

OK - I've stared at it for quite a while. I was hoping to make a few more suggestions regarding wording, but I'm finding it difficult to get to something I like more.

I was also hoping to squeeze in "productive" somewhere - I think the "productivity to performance ratio" or ("productivity + performance + readability" balance) is one of Nim's biggest strengths. It's easy to write code that's essentially as fast as anything, but is very readable.

But that's sort of trying to combine at least three separate "key features" at once, and I don't see how to squeeze it in. I can't even identify the least important of the current features.

I'll see if I have any wording inspiration tomorrow, but otherwise I'll merge and we can always follow-up later. Sorry again for the delay.

@ynfle
Copy link
Contributor Author

ynfle commented Apr 10, 2022

Let's give it some time then

@kytrinyx
Copy link
Member

kytrinyx commented Dec 4, 2022

@ynfle @ee7 Any chance we can get this merged? It doesn't have to be perfect. These are meant to entice people to try the track, not teach them about a fundamental truth about the language.

Having something on the site is better than having nothing on the site.

@ynfle ynfle closed this Dec 5, 2022
@ynfle ynfle mentioned this pull request Dec 5, 2022
@ynfle
Copy link
Contributor Author

ynfle commented Dec 5, 2022

For some reason, because I force pushed after closing, it won't reopen. #447 will supersede this, then

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.

Add key features
4 participants