Improve README.md - Githubissues

irena-flextool / flextool-web-interface

Web interface for IRENA FlexTool energy systems model.

https://www.irena.org/energytransition/Energy-System-Models-and-Data/IRENA-FlexTool

3 stars 2 forks source link

Improve README.md #9

Closed soininen closed 1 year ago

soininen commented 2 years ago

Changes based on user feedback:

[ ] ~~Explain more what is FlexTool: optimisation, open source, language, multi-sectoral...~~
[x] Explain a bit more what the web interface is about
[x] Add link to flextool repository and User guide
[ ] ~~Add screenshot showing the User guide link on the web interface~~

Installation

[x] Git clone will create a new directory
[x] Add a few words about the password: it doesn't have to be strong or secure when using a local server

Upgrade

[x] Move the section after Run. Users usually want to start the server immediately after installing
[x] Make the section self-contained: add steps to start Conda, activate the environment and cd to correct directory

Run

[x] Make the section self-contained: add steps to start Conda, activate the environment and cd to correct directory
[x] ~~Add screenshot of running server so user knows when is ready to go and~~ mention that the server will log on the terminal to avoid confusion