Update instructions for building the project

OCamlPro · Nov 2, 2023 · 3a7584c · 3a7584c
1 parent cfe3625
commit 3a7584c
Show file tree

Hide file tree

Showing 92 changed files with 854 additions and 784 deletions.
diff --git a/.drom b/.drom
diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -41,7 +41,7 @@ jobs:
         id: cache-opam
         with:
           path: ~/.opam
-          key: v2-${{ runner.os }}-superbol-vscode-platform-${{ matrix.ocaml-compiler }}-${{ hashFiles('opam/*.opam') }}
+          key: v2-${{ runner.os }}-superbol-studio-oss-${{ matrix.ocaml-compiler }}-${{ hashFiles('opam/*.opam') }}
 #          restore-keys: |
 #            v2-${{ runner.os }}-opam-${{ matrix.ocaml-compiler }}-
 
@@ -61,7 +61,7 @@ jobs:
 
       - run: opam pin add . -y --no-action
 
-      - run: opam depext -y superbol-vscode-platform polka-js-stubs interop-js-stubs node-js-stubs vscode-js-stubs vscode-languageclient-js-stubs vscode-json vscode-debugadapter vscode-debugprotocol superbol-free superbol_free_lib superbol_project cobol_common cobol_parser cobol_ptree ebcdic_lib cobol_lsp ppx_cobcflags pretty cobol_config cobol_indent cobol_preproc cobol_data cobol_typeck ez_toml ezr_toml
+      - run: opam depext -y superbol-studio-oss superbol-vscode-platform polka-js-stubs interop-js-stubs node-js-stubs vscode-js-stubs vscode-languageclient-js-stubs vscode-json vscode-debugadapter vscode-debugprotocol superbol-free superbol_free_lib superbol_project cobol_common cobol_parser cobol_ptree ebcdic_lib cobol_lsp ppx_cobcflags pretty cobol_config cobol_indent cobol_preproc cobol_data cobol_typeck ez_toml ezr_toml
 #        if: steps.cache-opam.outputs.cache-hit != 'true'
 
       - run: opam install -y opam/*.opam --deps-only --with-test

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+/superbol-studio-oss
 /superbol-vscode-platform
 /polka-js-stubs
 /interop-js-stubs

diff --git a/Makefile b/Makefile
diff --git a/Makefile.drom-tpl b/Makefile.drom-tpl
@@ -1,3 +1,4 @@
+# -*- Makefile -*-
 # Generated by "drom project"
 .PHONY: all build build-deps fmt fmt-check install dev-deps test
 .PHONY: clean distclean

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![Actions Status](https://github.com/ocamlpro/superbol-studio-oss/workflows/Main%20Workflow/badge.svg)](https://github.com/ocamlpro/superbol-studio-oss/actions)
 [![Release](https://img.shields.io/github/release/ocamlpro/superbol-studio-oss.svg)](https://github.com/ocamlpro/superbol-studio-oss/releases)
 
-# Superbol Studio OSS: A New Platform for COBOL
+# SuperBOL Studio OSS: A New Platform for COBOL
 
 ## Features
 

diff --git a/docs/index.html b/docs/index.html
@@ -10,14 +10,18 @@
     <div class="content">
       <div class="header">
         <h1>SuperBOL Studio OSS</h1>
-        <p>This is automatic document of the superbol-studio-oss Github project
-</p>
+        <p>SuperBOL Studio OSS is a new platform for COBOL</p>
       </div>
       <div class="section">
         <ul>
 <li><a href="https://get-superbol.com">Official Project</a></li>
-<li><a href="https://github.com/ocamlpro/superbol-studio-oss">Sources on Github</a></li>
-<li><a href="https://ocamlpro.github.io/superbol-studio-oss/sphinx">Documentation</a></li>
+
+<li><a href="https://github.com/ocamlpro/superbol-studio-oss">Project on Github</a></li>
+
+<li><a href="https://ocamlpro.github.io/superbol-studio-oss/sphinx">General Documentation</a></li>
+<!-- 
+<li><a href="https://ocamlpro.github.io/superbol-studio-oss/doc">API Documentation</a></li> -->
+
 <li><a href="https://github.com/ocamlpro/superbol-studio-oss/issues">Bug reports</a></li>
         </ul>
         <p>Authors:</p>

diff --git a/docs/index.html.drom-tpl b/docs/index.html.drom-tpl
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>SuperBOL Studio OSS</title>
+    <link rel="stylesheet" href="style.css?v=!{docs/style.css:>:read:md5}"/>
+    <link rel="icon" type="image/png" sizes="804x804"  href="favicon.png" />
+  </head>
+  <body>
+    <div class="content">
+      <div class="header">
+        <h1>SuperBOL Studio OSS</h1>
+        <p>!{description:html}</p>
+      </div>
+      <div class="section">
+        <ul>
+<li><a href="https://get-superbol.com">Official Project</a></li>
+!{li-github}
+![if:gen:docs]!{li-doc-gen}![fi]
+<!-- ![if:gen:sphinx]!{li-doc-api}![fi] -->
+!{li-bug-reports}
+        </ul>
+        <p>Authors:</p>
+        <ul>!{li-authors}</ul>
+      </div>
+      <div class="section">
+	!(readme-trailer:md-to-html)
+      </div>
+      <div class="trailer">
+        <hr/>
+        <p>Copyright © !{copyright}</p>
+      </div>
+    </div>
+  </body>
+</html>