Merge PR #18 SmartC to npm package

.github/workflows/build.yaml

@@ -17,13 +17,13 @@ jobs:
           node-version: 14
 
       - name: Run SmartC Tests
-        working-directory: ./dev
+        working-directory: ./
         run: |
           npm ci
           npm run test:ci
 
       - name: fix code coverage paths
-        working-directory: ./dev/coverage
+        working-directory: ./coverage
         run: sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' lcov.info
 
       - name: SonarCloud Scan

.gitignore

@@ -1,4 +1,3 @@
-dev/node_modules/*
-dev/lib
-dev/coverage
-stable
+node_modules/*
+dist
+coverage

README.md

@@ -9,16 +9,57 @@
 ## Objective
 To empower developers, allowing them to create complex and highly optimized smart contracts.
 
-## Usage
-[Run on gitpages](https://deleterium.github.io/SmartC/stable/index.html) the latest stable version.
-Optionally run the development version at [Vercel](https://smart-c.vercel.app) or choose a previous compiler version at [https://deleterium.info/SmartC/](https://deleterium.info/SmartC/).
-After compiling, information to create the Smart Contract is presented and it is possible to deploy the contract on your own local node.
+# Setup
+This library can be obtained through npm:
+```
+npm install smartc-signum-compiler
+```
+
+# Usage
+## Node
+```ts
+import { SmartC } from 'smartc-signum-compiler';
+
+//  Example: Simple compilation test
+try {
+    const startUpTest = new SmartC({
+        language: 'C',
+        sourceCode: '#pragma maxAuxVars 1\nlong a, b, c; a=b/~c;'
+    })
+    startUpTest.compile()
+    const assemblyText = startUpTest.getAssemblyCode()
+    const machineObject = startUpTest.getMachineCode()
+    // Do something
+} catch (e) {
+    return "Compilation error: " + e.message
+}
+```
+
+## Browser
+Your javascript file must be imported as module in the html.
+```ts
+import { SmartC } from 'https://cdn.jsdelivr.net/npm/[email protected]/dist/smartc.min.js';
+
+//  Example: Simple compilation test
+try {
+    const startUpTest = new SmartC({
+        language: 'C',
+        sourceCode: '#pragma maxAuxVars 1\nlong a, b, c; a=b/~c;'
+    })
+    startUpTest.compile()
+    const assemblyText = startUpTest.getAssemblyCode()
+    const machineObject = startUpTest.getMachineCode()
+    // Do something
+} catch (e) {
+    return "Compilation error: " + e.message
+}
+```
+
+## Web User Interface
+To be done
 
 ## Documentation / FAQ / Lessons
-Detailed technical information about the project can be found in compiler's page.
-After opening the desired version, click the **Help** button.
-A window will open with all avaliable documentation for that specific release.
-Check also [SmartC playlist on Youtube](https://www.youtube.com/playlist?list=PLyu0NNtb1eg3Gcg2JCrOle8MjtuFPb-Gi), with videos for starting, simulating and deploying a smart contract.
+Docs files can be found in this repo, at `doc` folder.
 
 ## Changelog
 Find [here](https://deleterium.github.io/SmartC/CHANGELOG) major upgrades between releases.