Merge pull request #14 from Delta456/master

Primitives, Variables, Operators and Mutability

Author: vbrazo

.gitignore

@@ -4,6 +4,8 @@
 *.vrepl_temp.v
 *.tmp.c
 a.out.tmp.c
+*.vrepl.v
+*.vrepl
 
 .DS_Store
 data/.DS_Store

README.md

@@ -1,9 +1,11 @@
 # V by Example
 
-> Learn V by Example
+> Learn V by Examples
 
 Note: This is still a work in progress
 
+Discord server : https://discord.gg/g33GaP
+
 ## Contributing
 
 For contributing see [CONTRIBUTING.md](CONTRIBUTING.md)

src/hello_world/README.md

@@ -5,21 +5,14 @@
  *
 */
 
-struct foo {
-    name string
-    number int
-}
-
-fn main() {
-
     print('Hello V\n')
+    print('Hello World')
 
     // This will print on a new line automatically
-    println('Hello V by Example')
+ //   println('Hello V by Example')
+ //   eprintln('Hello V by Example')
 
     /*println('I am Bob and I am $age old') */  // This won't print because `age` isn't defined.
    /* println(foo) */ // Also wouldn't work because custom str func not defined .
 
-    panic('Exiting from the program')
-    
-}
+    //panic('Exiting from the program')

src/hello_world/hello_world.v src/hello_world/code/hello.vsrc/hello_world/hello_world.v renamed to src/hello_world/code/hello.v

@@ -0,0 +1,46 @@
+# Hello V
+
+## Formatted Print
+
+Printing is handled by various I/O stream functions. One should know where to use them accordingly.
+
+- `print`: for printing the text to the output stream without a newline.
+
+- `println`: same as `print` but newline appended automatically.
+
+- `eprint`: same as `print` but the output goes to error stream (stderr).
+
+- `eprintln`: same as `println` but the output goes to error stream (stderr).
+
+- `panic`: outputs and exits from the program.
+
+```go
+print('Hello World')
+print('Hello V')
+```
+
+This will print `Hello WorldHello V`
+
+If you want to print the next line on a new line you would have to do `\n`.
+```go
+print('Hello World \n')
+print('Hello V ')
+```
+If you don't want to use `\n` then you can use `println` instead.
+
+## Comments
+
+V supports single line comments `//` and mutli-line comments `/* */`. They should be used for documenting the code for letting the other users know how the code works. It can also be used for temporarily commenting the code which has to be used later on.
+
+```go
+// This is a single line comment
+
+/* This is a 
+*  multi-line comment
+* /* This could be nested as well*/
+*/
+```
+
+## Exercises
+
+Try uncommenting the code in `hello.v` and see what happens.

src/hello_world/hello.md

@@ -0,0 +1,12 @@
+## Keywords
+
+V is a very small language so it has less keywords. There are around 25 keywords.
+
+| break | const  | continue | return  | defer     |
+|-------|--------|----------|---------|-----------|
+| else  | enum   | fn       | for     | struct    |
+| go    | goto   | if       | else    | else if   |
+| type  | pub    | fn       | in      | interface |
+| match | module | mut      | none    | or        |
+
+Like other languages, they cannot be used as a variable.

src/keywords.md

@@ -0,0 +1,112 @@
+## Operators
+
+V supports the following operators:
+
+### Basic Operators
+
+- `+` (addition) for int, float and string
+
+- `-` (subtraction) for int and float
+
+- `*` (multiplication) for int and float
+
+- `/` (division) for int and float
+
+- `%` (modulos) for int
+
+```go
+println(3 + 5)
+println(2.0 + 5.0)
+println('hello' + 'world')
+
+println(9 - 10)
+println(7.0 - 5.0)
+
+println(3 * 5)
+println(2.0 * 4)
+
+println(23 / 3)
+println(25.0 / 5.0)
+
+println(27 % 5)
+println(27 % 3)
+```
+Output :
+```go
+8
+7.0
+hello world
+
+-1
+2.0
+
+15
+8.0
+
+7
+5.0
+
+2
+0
+```
+
+**NOTE**: Unlike other languages, V doesn't allow modulus with float.  
+
+### Comparsion Operators
+
+- `>` greater than
+
+- `<` lesser than
+
+- `==` equal to
+
+- `>=` greater than equal to
+
+- `<=` lesser than equal to
+
+- `!=` not equal to
+
+### Boolean Operators
+
+- `&&` and
+
+- `||` or
+
+- `!` not
+
+
+### Bitwise Operators
+
+- `>>` left bitshift
+
+- `<<` right bitshift
+
+- `&` bitwise and
+
+- `|` bitwise or
+
+- `^` bitwise xor
+
+### Assignments Operators
+
+- `+=` same as `foo = foo + var`
+
+- `-=` same as `foo = foo - var`
+
+- `*=` same as `foo = foo * var`
+
+- `/=` same as `foo = foo / var`
+
+- `&=` same as `foo = foo & var`
+
+- `|=` same as `foo = foo | var`
+
+- `>>=` same as `foo = foo >> var`
+
+- `<<=` same as `foo = foo << var`
+
+### Special Operators
+
+- `in` for membership
+
+- `none` for optional

src/operator.md

@@ -0,0 +1,50 @@
+## Primitives
+
+V has less number of primitive types like Go.
+
+### Basic Types
+
+- bool either `true` or `false`
+
+- string
+
+- integer type `int`
+
+- float type `float`  
+
+- rune (Unicode string)
+
+
+## Compound Types
+
+- arrays `[]`
+
+- map `{}`
+
+- struct 
+
+## Integer
+
+Integer is sub-classified into `signed` and `unsigned`. `signed` means positive or negative and `unsigned` means positive only. 
+
+
+### Singed Integer
+
+| Type   |   Size   |                                   Range |
+|--------|:--------:|----------------------------------------:|
+| int8   |  8 bits  |                             -128 to 2<sup>7</sup> -1 |
+| int16  |  16 bits |   -2<sup>15</sup> to 2<sup>15</sup> - 1 |
+| int32  |  32 bits |   -2<sup>31</sup> to 2<sup>31</sup> - 1 |
+| int64  | 64 bits  | -2<sup>63</sup> to 2<sup>63</sup> - 1   |
+| int128 | 128 bits | -2<sup>127</sup> to 2<sup>127</sup> - 1 |
+
+### Unsigned Integer
+
+| Type   |   Size   |                                   Range |
+|--------|:--------:|----------------------------------------:|
+| u8   |  8 bits  |                             0 to 2<sup>17</sup>  -1|
+| u16  |  16 bits |   0 to 2<sup>15</sup> - 1 |
+| u32  |  32 bits |  0 to 2<sup>31</sup> - 1 |
+| u64  | 64 bits  | 0 to 2<sup>63</sup> - 1   |
+| u128 | 128 bits | 0 to 2<sup>127</sup> - 1 |
+