feat: enhance project readme

[emarc99]

Closes: #1219

I just re-did the video recording to better fit my vision for the task and thought to share as update while still editing.

The video recording can be found here.
The runtime might be high but will be reduced to around 3- 4 mins.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.18%. Comparing base (29a13d0) to head (2146602).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1293      +/-   ##
==========================================
+ Coverage   80.10%   80.18%   +0.08%     
==========================================
  Files         104      104              
  Lines       14819    14819              
==========================================
+ Hits        11871    11883      +12     
+ Misses       2948     2936      -12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dj8yfo]

@emarc99 i kind of like it

1. I didn't hear a single word in both a browser and loom android app, so i suppose the video is without audio. Please let me know if it's not true.
2. I suggest you do a short 3-4 min version with audio commentary based on long version and add it to the very beginning of readme with thumbnail, so it's prominent and is a first thing one sees when opening the repo. I think it should be hosted on github, so should be done approximately by steps of Video from Github Repository heading at https://www.geeksforgeeks.org/how-to-embed-a-video-into-github-readme-md/.
3. The long version is kind of good too due to you handling various issues you stumbled across, so it should be added as a hyperlink to your loom video just under the embedded video.
4. The short version should mention that there're no issues with having to install rust toolchain/near tools if one clones the template cargo-near-new-project-name and launches codespaces from there, as suggested in the project's readme https://github.com/njelich/cargo-near-new-project-template/assets/12912633/d59d89f1-8bc4-42f1-8e0d-842521d87768 . I'll double check this is true, please let me know if this appears not true for you. You shouldn't re-record anything, just add a short mention at the end of short video that everything is pre-installed into devcontainer of cargo-near-new-project-name, and that it's a shorter path than you followed in the full version of video on a default codespaces container.

[dj8yfo]

@emarc99 please discard point 4. for now . It had outdated cargo-near and near-cli binaries, not updated to freshes by default.
I tested the template and it needs some updates from near/cargo-near-new-project-template#13 + neardevcontainer publish with newest rust

[emarc99]

@emarc99 i kind of like it

1. I didn't hear a single word in both a browser and loom android app, so i suppose the video is without audio. Please let me know if it's not true.
2. I suggest you do a short 3-4 min version with audio commentary based on long version and add it to the very beginning of readme with thumbnail, so it's prominent and is a first thing one sees when opening the repo. I think it should be hosted on github, so should be done approximately by steps of Video from Github Repository heading at https://www.geeksforgeeks.org/how-to-embed-a-video-into-github-readme-md/.
3. The long version is kind of good too due to you handling various issues you stumbled across, so it should be added as a hyperlink to your loom video just under the embedded video.
4. The short version should mention that there're no issues with having to install rust toolchain/near tools if one clones the template cargo-near-new-project-name and launches codespaces from there, as suggested in the project's readme https://github.com/njelich/cargo-near-new-project-template/assets/12912633/d59d89f1-8bc4-42f1-8e0d-842521d87768. I'll double check this is true, please let me know if this appears not true for you. You shouldn't re-record anything, just add a short mention at the end of short video that everything is pre-installed into devcontainer of cargo-near-new-project-name, and that it's a shorter path than you followed in the full version of video on a default codespaces container.

1. You are right on all points. This video was re-made with a voice script I've made for better workflow. So, the audio will be added post-editing (with bg music).
2. Yes, I intended to trim the video during editing, and thanks for the resources.
3. I will link the long version as advised.
4. I tried this template as you suggested in the video you did. It works perfectly all through showing transaction is recorded on nearblocks.io. Just few issues I noticed;
   • (i) cargo near new: this command creates a template from latest near version which failed to compile due to versions of rust and cargo-near in the devcontainer being outdated.

I will definitely add the short mention of the pre-installed devcontainer at the end of the video as advised.

[emarc99]

@emarc99 please discard point 4. for now . It had outdated cargo-near and near-cli binaries, not updated to freshes by default. I tested the template and it needs some updates from near/cargo-near-new-project-template#13 + neardevcontainer publish with newest rust

Will do, sir.

[dj8yfo]

@emarc99 with near/near-devcontainers#2 merged and near/cargo-near-new-project-template#13 pending merge any time now,
please take 4. back into account.
Please include link #1294 just under the video

[emarc99]

@emarc99 with near/near-devcontainers#2 merged and near/cargo-near-new-project-template#13 pending merge any time now, please take 4. back into account. Please include link #1294 just under the video

All duly noted, sir.

[dj8yfo]

@emarc99 is there any version with sound?

We need a short 3-4 minute version with sound/audio commentary uploaded to github, and a link to your loom account to initial longer 30 min version, but with sound, too.

As of now there's 11 min version without sound, as far as i can see hear. Please stop 🛑 sir-ing everyone around.

[emarc99]

@emarc99 is there any version with sound?

We need a short 3-4 minute version with sound/audio commentary uploaded to github, and a link to your loom account to initial longer 30 min version, but with sound, too.

As of now there's 11 min version without sound, as far as i can see hear. Please stop 🛑 sir-ing everyone around.

Apologies for that. I made the recent update to show some activity. I was busy with the recent ODboost. The video editing might (or will) take some time, so I will open the PR to signal completion. And yes, no audio still. The 11 minutes recent video will be edited (sped up) for the final 3-4 mins cut, plus the audio and effects. Thanks for your patience. Kindly, give me till Wednesday.

[dj8yfo]

@emarc99 there's really no rush with it. I'll consider the issue locked to you for a month.

[emarc99]

Awesome, thanks! Really appreciate the time.