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.

Sign up for GitHub

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

Jump to bottom

Complete user's guide #324

Closed
sebastian-peter opened this issue Aug 30, 2022 · 0 comments · Fixed by #635
Closed

Complete user's guide #324

sebastian-peter opened this issue Aug 30, 2022 · 0 comments · Fixed by #635
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sebastian-peter
Copy link
Member

sebastian-peter commented Aug 30, 2022 •
edited
Loading

The user's guide is lacking some info about steps that one is required to take to use Intellij with SIMONA:

  • Download and set correct JDK
  • Install Scala plugin
  • Download and set correct Scala SDK

(some hints on how to do that can be found here, besides using JDK 17)

In my opinion, we should not describe the points above in-depth, because the procedure might change for future versions of Intellij.

The text can probably be restructured while adding the new info.

In the longterm, one can also think about separating the install/run guide into user's guide (use a pre-packaged jar) and dev's guide (use Intellij etc.).
@sebastian-peter sebastian-peter added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 30, 2022
@SimonHuette SimonHuette mentioned this issue Nov 2, 2023
Merged
SimonHuette added a commit that referenced this issue Nov 14, 2023
@SimonHuette
Merge branch 'dev' into sh/#324-updateusersguide
7ac43d0
SimonHuette added a commit that referenced this issue Nov 20, 2023
@SimonHuette
Merge branch 'dev' into sh/#324-updateusersguide
f377f11
SimonHuette added a commit that referenced this issue Nov 25, 2023
@SimonHuette
Merge branch 'dev' into sh/#324-updateusersguide
ad0a8e8
SimonHuette added a commit that referenced this issue Nov 25, 2023
@SimonHuette
Merge remote-tracking branch 'origin/sh/#324-updateusersguide' into sh/…
a9c66c4 
…#324-updateusersguide

# Conflicts:
#	docs/readthedocs/usersguide.md
SimonHuette added a commit that referenced this issue Dec 2, 2023
@SimonHuette
Merge branch 'dev' into sh/#324-updateusersguide
65addea
danielfeismann added a commit that referenced this issue Dec 3, 2023
@danielfeismann
Merge branch 'dev' into sh/#324-updateusersguide
1aa22d6
sebastian-peter added a commit that referenced this issue Dec 7, 2023
@sebastian-peter
Merge branch 'dev' into sh/#324-updateusersguide
410ba18
danielfeismann added a commit that referenced this issue Dec 8, 2023
@danielfeismann
Merge pull request #635 from ie3-institute/sh/#324-updateusersguide
a259c4c 
complete users guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

complete users guide ie3-institute/simona
1 participant
@sebastian-peter