Merge pull request #18 from zong-zhe/add-doc-link

doc: add document for the IR Specification in README.md

Author: i-zhen

README.md

@@ -30,7 +30,9 @@ The Smart Intermediate Representation(short for IR) project is a new compiler fr
 
 Since the circulation of Blockchain and Smart Contracts, there have been many incidents of exploitation. These incidents are mainly caused by attacks on unsafe smart contracts such as reentrancy issues, and compiler bugs. In the existing cases, it is difficult to investigate or locate once the attack occurs. Most safe/secure cases also require 3rd-party auditing which is very costly.
 
-We propose a universal technical solution to be adapted to any programming language to help blockchain platform/developer make their smart contract trust, safe and high performance.
+Meanwhile, to wring the most performance out of a regular gas allowance, or something else. It's important to optimize both on-chain and off-chain scenarios.
+
+Currently, we propose a universal technical solution to be adapted to any programming language to help blockchain platform/developer make their smart contract safer, high performance and multi-scenario compatibility. 
 
 ## Installation
 
@@ -71,11 +73,7 @@ docker run smartir/cli:latest ir_cli build sir/example/hello_world.ir
 
 ## Documentation
 
-coming soon
-
-<!--
 The IR Specification document is [here](./doc/specification/SmartIR.md)
--->
 
 ## Roadmap
 

doc/specification/SmartIR.md

@@ -5,7 +5,7 @@
 
 ## Informal Description of IR
 
-In this section, we discuss various aspects of Smart IR (hereafter IR).
+In this section, we discuss various aspects of Smart Intermediate Representation (hereafter IR).
 
 ### A Simple Example
 The top-level structure of IR is `contract`, `type`, `metadata` and the secondary structure is `state` and `fn`. The following example is a non-recursive Fibonacci sequence function written in IR:

docker/ir-cli-builder/README.md

@@ -1,4 +1,4 @@
-## The Smart IR Builder Image
+## The Smart Intermediate Representation Builder Image
 
 The `smartir/smart-ir-builder` image embeded a development enviroment for developers to code, build and test the project.
 

smart_ir/src/ir/cfg.rs

@@ -16,7 +16,7 @@ pub const IR_MAP_ITER_TY: &str = "ir.map.iter";
 pub const IR_PARAMPACK_TY: &str = "ir.builtin.parampack";
 pub const IR_STORAGE_PATH_TY: &str = "ir.builtin.StoragePath";
 
-/// Smart IR Expression
+/// SIR Expression
 /// Identifier refer to a variable, Identifier(0) -> %0
 /// Instr directly refer to an instruction
 /// Literal represents the literal quantity of different basic types