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: more clearer programming languages version requirements #818

Closed
Fun131n opened this issue May 16, 2023 · 1 comment · Fixed by #827
Closed

docs: more clearer programming languages version requirements #818

Fun131n opened this issue May 16, 2023 · 1 comment · Fixed by #827
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Fun131n
Copy link

Fun131n commented May 16, 2023

Now

If you are using MacOS or Linux. We recommend sdkman and nvm for managing the versions of Java and NodeJS respectively.

# quick install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
# quick install sdkman
curl -s "https://get.sdkman.io" | bash
# install nodejs 
nvm install 16.15.0 && nvm use 16.15.0 && corepack enable
# install java development kit
sdk env install
# install rust toolchain
curl -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly --profile minimal -y && source "$HOME/.cargo/env"

depending on the current document, I encountered the following problem

  • Use the default installation of rust (stable),java(11),nodejs(18.16.0 LTS),some methods that are not supported in higher versions cause ‘’make install‘’ to report errors and have to take time to reinstall lower version
  • It is easy to ignore the version requirements hidden inside the recommended installation method, when I get used to using "apt" to install. actually after multiple errors were reported , i come back to the document just find the version

What documentation do you want?

There are two parts: one is the version requirement and the other is the recommend install . just like

Programming Languages

  • rust toolchain (nightly)
  • java 8
  • nodejs 16.15.0
    ...

PS: if note that later versions are not supported would be the best ❤

If you are using MacOS or Linux. We recommend sdkman and nvm for managing the versions of Java and NodeJS respectively.

# quick install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
# quick install sdkman
curl -s "https://get.sdkman.io" | bash
# install nodejs 
nvm install 16.15.0 && nvm use 16.15.0 && corepack enable
# install java development kit
sdk env install
# install rust toolchain
curl -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly --profile minimal -y && source "$HOME/.cargo/env"
@Fun131n Fun131n added the documentation Improvements or additions to documentation label May 16, 2023
@arucil arucil self-assigned this May 17, 2023
@arucil
Copy link
Contributor

arucil commented May 17, 2023

Thanks, I will add a clear description about the version requirement in a minute.

@arucil arucil linked a pull request May 17, 2023 that will close this issue
arucil added a commit that referenced this issue May 17, 2023
Add clearer description of required programming languages and their
versions. Solves #818
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants