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

Updated the getting started docs for linux based OS. #537

Merged
merged 2 commits into from
Dec 12, 2022

Conversation

Dabjazz
Copy link
Contributor

@Dabjazz Dabjazz commented Dec 8, 2022

⚠ PLEASE DO NOT DELETE THE TEXT BELOW ⚠

Pull request's description

*This PR is linked to #536 *
Added the instructions to run the built file on Linux based OS. Getting-Started Docs only mentioned the instructions for windows based OS previously.

Checklist before merging (please do not edit)

You must review you work before to submit the review to others.

Self-review of your content

Remember the content must be readable and understandable by someone else than yourself.

  • [ ✅ ] From a technical point of view.
  • [ ✅ ] From a grammatical point of view (spelling mistakes, typos, clarity, etc.), and following the guidelines at the bottom.

External reviews of your content

  • [ ❌ ] You requested a technical review.
  • [ ❌ ] You requested a grammatical review.
  • [ ❌ ] You validated with @K0rdan or @alexgeron-Luos that it is safe to merge.

Some guidelines to keep in mind

  • Colons (:), semi-colons (;), exclamation (!), and interrogation points (?) are not preceded by a space (like full stops and commas). E.g.: Colons!

  • File names and/or address are put in italic. E.g.: The file main.c.

  • Functions, variables, or more generally short codes are put between grave accents. E.g.: To obtain code(), type `code()`.

  • Long codes are put into blocks of code with three grave accent on each side, and the language's name:

    ```c

    // Some C language

    ```

  • "Luos engine" has a upper case on the L for "Luos" and lower case on the e for "engine".

  • We call it "Luos engine" as a proper name, and not "the Luos engine".

  • Following that fashion, anything that's owned by "Luos engine" implies that we must use 's as the standard English rule to show the possessive case, e.g. "Luos engine's API".

  • The names pipe, gate, inspector, sniffer, app or application, driver, etc. have a lower case and can be refereed with the determiner the. E.g.: The inspector.

@vercel
Copy link

vercel bot commented Dec 8, 2022

@Dabjazz is attempting to deploy a commit to the Luos Team on Vercel.

A member of the Team first needs to authorize it.

@Simonbdy Simonbdy self-requested a review December 8, 2022 15:50
@Simonbdy Simonbdy self-assigned this Dec 8, 2022
@Simonbdy
Copy link
Collaborator

Simonbdy commented Dec 8, 2022

Thank you @Dabjazz, we will review it as soon as we have time to do so.
Could you edit the description and add the following sentence in Pull request's description's category?
This PR is linked to #536.

@vercel
Copy link

vercel bot commented Dec 8, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Dec 12, 2022 at 6:54PM (UTC)

Copy link
Collaborator

@Simonbdy Simonbdy left a comment

Choose a reason for hiding this comment

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

I included the changes in a "Tip" blockquote and deleted the sentence about exiting the terminal because it is supposed to be general Linux knowledge.
Ok for me to merge, thanks @Dabjazz

However I'd like @K0rdan to have a look to be sure that everything is in order (Thanks).

@Simonbdy Simonbdy requested a review from K0rdan December 12, 2022 18:49
Copy link
Contributor Author

@Dabjazz Dabjazz left a comment

Choose a reason for hiding this comment

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

Looks Great! More imperative!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

[DOC] Addition of steps to execute the No-Board service in Linux based OS.
3 participants