Browse Source

Updated website

tags/v0.6.4
champii 1 year ago
parent
commit
83014e3b51
8 changed files with 44 additions and 14 deletions
  1. 3
    0
      Makefile
  2. 3
    3
      README.md
  3. 21
    3
      docs/README.md
  4. 4
    4
      docs/build.md
  5. 5
    1
      docs/changelog.md
  6. 3
    2
      docs/index.html
  7. 1
    1
      docs/vendor/prism-og.js
  8. 4
    0
      scripts/release_from_develop.sh

+ 3
- 0
Makefile View File

@@ -76,6 +76,9 @@ test:
76 76
 	@$(call section_title,Testing)
77 77
 	@go test og/tests
78 78
 
79
+doc:
80
+	@docsify serve ./docs
81
+
79 82
 clean:
80 83
 	@$(call section_title,Cleaning src folder)
81 84
 	@rm -f $(RES)

+ 3
- 3
README.md View File

@@ -1,4 +1,4 @@
1
-Og-Lang *v0.6.3* (Optimistic Golang)
1
+Og-Lang *DEV* (Optimistic Golang)
2 2
 ===
3 3
 
4 4
 ### [Documentation](https://champii.github.io/og)
@@ -18,8 +18,8 @@ Testers and Contributors are most welcome
18 18
 ## Demo
19 19
 
20 20
 <p float="left">
21
-  <img height="220" src="https://github.com/Champii/og/raw/master/docs/hello_preview.gif" />
22
-  <img height="220" src="https://github.com/Champii/og/raw/master/docs/og_preview.gif" />
21
+  <img height="220" src="https://github.com/Champii/og/raw/master/docs/_media/hello_preview.gif" />
22
+  <img height="220" src="https://github.com/Champii/og/raw/master/docs/_media/og_preview.gif" />
23 23
 </p>
24 24
 
25 25
 

+ 21
- 3
docs/README.md View File

@@ -5,15 +5,33 @@
5 5
 'Og' is to be pronounced `Oh-Jee` and stands for ~~`Orgasmic Granny`~~ `Optimistic Golang`  
6 6
 It is an indentation based language mainly inspired from [Livescript](http://livescript.net) that compiles to GoLang.
7 7
 
8
+```og
9
+!main
10
+
11
+class Oglang<T>
12
+  Foo T
13
+  GetFoo: T -> @T
14
+
15
+main ->
16
+  foo := Oglang<int>
17
+    Foo: 42
18
+
19
+  foo.GetFoo()
20
+```
21
+
22
+Go to the [Features](/features.md) section for more exemples of code.
23
+
8 24
 ### Bootstraped Language
9 25
 ---
10 26
 
11
-Oglang is written in itself. It is said to be a 'Bootstraped' language. In fact, Oglang needs the previous release of itself to build itself.
27
+Oglang is written in itself. It is said to be a 'Bootstraped' language. In fact, Oglang needs the previous release of itself to build itself.  
28
+See the [Build](/build.md) section for more details
29
+
30
+Go to the [./lib](https://github.com/champii/og/tree/master/lib) folder on github for both Oglang and compiled Golang sources.  
12 31
 
13
-See the [Src](https://github.com/champii/og/tree/master/src) folder for both Oglang and Golang sources.  
14 32
 Built with [Antlr4](https://github.com/antlr/antlr4) from their Golang grammar.
15 33
 
16 34
 ### Goal
17 35
 ---
18 36
 
19
-The main goal is to simplify the syntax, to borrow some concepts from Livescript and other functional languages, to implement Generics and macro processing, as well as some syntaxic sugar to avoid all the boilerplate code Golang forces us into.
37
+The main goal is to simplify the syntax, to borrow some concepts from Livescript and other functional languages, to implement Generics and macro processing, as well as some syntaxic sugar to avoid all the boilerplate code Golang forces us into.

+ 4
- 4
docs/build.md View File

@@ -21,7 +21,7 @@ Simply call
21 21
 make
22 22
 ```
23 23
 Calling `make` will regenerate the grammar,  
24
-Compile the existing sources from the previous Og (`og lib`)  
24
+Compile the existing sources from the previous Og (`$> og lib`)  
25 25
 And run the tests.  
26 26
 Needs the last official `og` binary version at global scope.  
27 27
 
@@ -31,11 +31,11 @@ make re
31 31
 ```
32 32
 
33 33
 This cleans the `lib` folder,  
34
-Then compiles og from the previous global version (`og lib`)  
35
-Then recomiles it from itself (`./og lib`)  
34
+Then compiles og from the previous global version (`$> og lib`)  
35
+Then recomiles it from itself (`$> ./og lib`)  
36 36
 And run the tests  
37 37
 
38
-![make](https://github.com/Champii/og/raw/master/docs/_media/og_preview.png)
38
+![make](https://github.com/Champii/og/raw/master/docs/_media/og_preview.gif)
39 39
 
40 40
 ### Simple test
41 41
 ```bash

+ 5
- 1
docs/changelog.md View File

@@ -4,9 +4,13 @@
4 4
 
5 5
 ## v0.6.3
6 6
   - Generics for Struct
7
-    ```go
7
+    ```og
8 8
       struct Foo<T>
9 9
         bar T
10
+
11
+      main ->
12
+        foo := Foo<int>
13
+          bar: 2
10 14
     ```
11 15
 
12 16
 ## v0.6.2

+ 3
- 2
docs/index.html View File

@@ -2,7 +2,7 @@
2 2
 <html lang="en">
3 3
 <head>
4 4
   <meta charset="UTF-8">
5
-  <title>Oglang</title>
5
+  <title>Oglang DEV</title>
6 6
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7 7
   <meta name="description" content="Description">
8 8
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
@@ -65,11 +65,12 @@
65 65
   <script>
66 66
     window.$docsify = {
67 67
       coverpage: true,
68
-      name: 'Oglang',
68
+      name: 'Oglang DEV',
69 69
       repo: 'https://github.com/Champii/og/',
70 70
       loadSidebar: true,
71 71
       autoHeader: true,
72 72
       subMaxLevel: 3,
73
+      auto2top: true,
73 74
       // themeColor: '#ff2222'
74 75
     }
75 76
   </script>

+ 1
- 1
docs/vendor/prism-og.js View File

@@ -1,7 +1,7 @@
1 1
 Prism.languages.og = {
2 2
 	'comment': /\/\/.*/,
3 3
 	'builtin': /\b(?:bool|byte|complex(?:64|128)|error|float(?:32|64)|rune|string|u?int(?:8|16|32|64)?|uintptr|append|cap|close|complex|copy|delete|imag|len|make|new|panic|print(?:ln)?|real|recover)\b/,
4
-	'keyword': /\b(?:fn|in|break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,
4
+	'keyword': /\b(?:class|fn|in|break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,
5 5
 	'boolean': /\b(?:_|iota|nil|true|false)\b/,
6 6
 	'funcName': { // TODO
7 7
 		pattern: /^(\w+) *(?=:?)(?=.+?)(?=->)/,

+ 4
- 0
scripts/release_from_develop.sh View File

@@ -43,6 +43,8 @@ echo "Preparing next version: $NEW_TAG"
43 43
 
44 44
 sed -i -e "s/DEV: Current version/$NEW_TAG: Current version/g" docs/changelog.md
45 45
 
46
+sed -i -e "s/DEV/$NEW_TAG/g" docs/index.html
47
+
46 48
 sed -i -e "s/DEV/$NEW_TAG/g" docs/usage.md
47 49
 
48 50
 sed -i -e "s/DEV/$NEW_TAG/g" docs/_coverpage.md
@@ -83,6 +85,8 @@ echo "Restoring DEV tag in develop"
83 85
 
84 86
 sed -i -e "s/$NEW_TAG: Current version/DEV: Current version\\n\\n## $NEW_TAG/g" docs/changelog.md
85 87
 
88
+sed -i -e "s/$NEW_TAG/DEV/g" docs/index.html
89
+
86 90
 sed -i -e "s/$NEW_TAG/DEV/g" docs/_coverpage.md
87 91
 
88 92
 sed -i -e "s/$NEW_TAG/DEV/g" docs/usage.md

Loading…
Cancel
Save