ISISComputingGroup / lewis-ess

Let's write intricate simulators!
GNU General Public License v3.0
21 stars 19 forks source link

Documentation needs a Quickstart Guide #271

Closed MikeHart85 closed 6 years ago

MikeHart85 commented 6 years ago

As discussed in #270, related to #263.

The documentation needs an entrypoint that allows new users to very quickly and simply install, run and see lewis in action. This section should be as simple as possible, aiming to give a quick cross-section of use cases and features without going into any depth.

Currently we open with multiple ways to install Lewis, followed by details of how specific adapter parameters work. This is not a good entrypoint and does not give a new user a clear picture of what Lewis is or does.