Documentation - minor alignments

[fnchooft]

Hi, great tool!

I think the user needs 2 or 3 instructions - and maybe the installer/packager should be a bit smarter.

Adding a README.md would be sufficient.

Steps I did:

git clone git@github.com:novaframework/nova_shell.git
cd nova_shell/
rm rebar.lock  # pinned on some old lib (cowlib) which does not compile anymore.
rebar3 compile
cd priv/assets/nova-shell/
npm install
cd dist
ls *. js

I had to edit:

+++ b/src/views/nova_shell_main.dtl
@@ -15,6 +15,6 @@
       var base_url = "{% url "" application="nova_shell" %}";
     </script>
     <script src="https://cdn.jsdelivr.net/npm/xterm@4.19.0/lib/xterm.js"></script>
-    <script src="{% url "assets/nova-shell/dist/main.js" application="nova_shell" %}"></script>
+    <script src="{% url "assets/nova-shell/dist/main.1f19ae8e.js" application="nova_shell" %}"></script>
   </body>

But it seems that could all be automated.

Run:

rebar3 shell / rebar3 nova serve

Result looks like this:

[burbas]

Thanks for commenting on this. I had actually forgot about this repo, but will for sure update the docs for it now when I know someone might use it :-)