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

Write user-level installation instructions and simple tutorial #768

Open
mobernabeu opened this issue Nov 8, 2021 · 1 comment
Open

Write user-level installation instructions and simple tutorial #768

mobernabeu opened this issue Nov 8, 2021 · 1 comment
Assignees
@CharlesQiZhou

Comments

@mobernabeu
Copy link
Contributor

We've got developer-orientated installation instructions here: https://github.com/hemelb-codes/hemelb/blob/main/INSTALL

However, it would be good to have a more user-orientated version that: a) also refers to installing and running the setup tool, and) demonstrates a tutorial of getting a simulation up and running starting from a .stl file.

@CharlesQiZhou could you please have a first go at this based on our meeting on 29/11?
@rupertnash
Copy link
Member

See also the doc branch!

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

@CharlesQiZhou CharlesQiZhou

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mobernabeu @rupertnash @CharlesQiZhou