Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bistcuite committed Feb 24, 2023
1 parent 4e2952a commit 4ee83da
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/latest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h1 class="menu-title">Hascal Documentation</h1>
<main>
<h1 id="overview"><a class="header" href="#overview">Overview</a></h1>
<h2 id="introduction"><a class="header" href="#introduction">Introduction</a></h2>
<p><a href="https://hascal.github.io">Hascal</a> is a general-purpose open source programming language that makes it easy to build simple,optimal, reliable, and efficient software. More features of Hascal :</p>
<p><strong><a href="https://hascal.github.io">Hascal</a></strong> is a general purpose and open source programming language designed to build optimal, maintainable, reliable, and efficient software. More features of Hascal :</p>
<ul>
<li><input disabled="" type="checkbox" checked=""/>
Easy to use and easy to learn</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/lang/0_install.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ <h2 id="windows-users"><a class="header" href="#windows-users">Windows Users</a>
&gt; make windows
</code></pre>
<p><em><strong>Now your Hascal compiler is ready to use in <code>dist</code> folder, you can add it to <code>$PATH</code>.</strong></em></p>
<p><strong>NOTE</strong>: <strong>The latest version of Hascal should always be used, older versions have bugs when running binary versions of Hascal.</strong></p>
<p><strong>NOTE</strong>: <strong>The latest version of Hascal should always be used. Old versions have bugs when running binary versions of Hascal.</strong></p>

</main>

Expand Down
22 changes: 11 additions & 11 deletions docs/latest/lang/1_hello_world.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,22 +143,22 @@ <h1 class="menu-title">Hascal Documentation</h1>
<div id="content" class="content">
<main>
<h1 id="hello-world"><a class="header" href="#hello-world">Hello World!</a></h1>
<p>Now that you have successfully installed Haskall, let's write our first program with it. You will write a program that prints <code>Hello World!</code> on the terminal.</p>
<p>Now that you have successfully installed Hascal, let's write our first program with it. You will write a program that prints <code>Hello World!</code> on the terminal.</p>
<h2 id="creating-a-project-directory"><a class="header" href="#creating-a-project-directory">Creating a project directory</a></h2>
<p>You can wite your hascal programs every where but We suggest that you create a directory for your project.</p>
<p>First create a directory in your home directory(or anywhere else):</p>
<p>You can write your Hascal programs every where but, we suggest that you create a directory for your project.</p>
<p>At first, create a directory in your home directory(or anywhere else):</p>
<pre><code>mkdir hello_world
cd hello_wrold
</code></pre>
<h2 id="writing-the-code"><a class="header" href="#writing-the-code">Writing the code</a></h2>
<p>Next make a new file and name it <code>main.has</code>. Hascal files should end with <code>.has</code> extension.</p>
<p>Now open your code editor(If you are using <code>vscode</code> install hascal extension for better coding from <a href="https://github.com/hascal/vscode">this link</a>) and write following code in <code>main.has</code> :</p>
<p>Now open your code editor (If you are using <code>vscode</code> install hascal extension for better coding from <a href="https://github.com/hascal/vscode">this link</a>) and write the following code in <code>main.has</code> :</p>
<pre><code class="language-typescript">function main() : int {
print(&quot;Hello World!&quot;)
return 0
}
</code></pre>
<p>Save the file, and back to terminal and enter following command to build your program :</p>
<p>Save the file, and return to the terminal and enter the following command to build your program :</p>
<pre><code>hascal main.has
</code></pre>
<p>Now run the generated excutable file :</p>
Expand All @@ -171,24 +171,24 @@ <h2 id="writing-the-code"><a class="header" href="#writing-the-code">Writing the
</code></pre>
<p>Congratulations - you just wrote and executed your first Hascal program!</p>
<h2 id="reviewing-the-code"><a class="header" href="#reviewing-the-code">Reviewing the code</a></h2>
<p>Let's review the our simple program. Here's the first piece of the program :</p>
<p>Let's review our simple program. Here's the first piece of the program:</p>
<pre><code class="language-typescript">function main() : int {

}
</code></pre>
<p>These lines defines a function that returns an integer number. The <code>main</code> function is the entry point of your program and it always should return <code>int</code>(an integer), if there were parameters, they would go inside the parentheses, <code>()</code>.</p>
<p>Also, note function statements should be in <code>{}</code> and you write function codes inside <code>{}</code>.</p>
<p>These lines define a function that returns an integer number. The <code>main</code> function is the entry point of your program and it should always return <code>int</code>(an integer). If there were parameters, they would go inside the parentheses, <code>()</code>.</p>
<p>Also, note that function statements should be in <code>{}</code> and you can write function codes inside <code>{}</code>.</p>
<p>Inside the <code>main</code> function is the following code :</p>
<pre><code class="language-typescript">print(&quot;Hello World!&quot;)
</code></pre>
<p>This code print the passed arguments, you can pass more parameters :</p>
<pre><code class="language-typescript">print(&quot;Hello World!&quot;,42,3.14)
</code></pre>
<p>After the calling <code>print</code> command is following statemetn :</p>
<p>After the calling <code>print</code> command, there is the following statement :</p>
<pre><code class="language-typescript">return 0
</code></pre>
<p>It returns <code>0</code> at end of the function, every function that returns a value(declared with <code>:</code> after <code>()</code> in function declaration) should return a value with mentioned type. </p>
<p>Returning the <code>0</code> value in main function tell the OS that your program executed successfully.</p>
<p>It returns <code>0</code> at the end of the function, every function that returns a value(declared with <code>:</code> after <code>()</code> in a function declaration) should return a value corresponding to the type.</p>
<p>Returning the <code>0</code> value in main function tell the OS that your program has executed successfully.</p>

</main>

Expand Down
2 changes: 1 addition & 1 deletion docs/latest/lang/2_project_manager.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h1 class="menu-title">Hascal Documentation</h1>
<div id="content" class="content">
<main>
<h1 id="project-manager"><a class="header" href="#project-manager">Project Manager</a></h1>
<p>Hascal has a builtin build system and project manager. This tool builds and runs your project, installs dependencies.</p>
<p>Hascal has a builtin build system and project manager. This tool builds and runs your project, and installs dependencies.</p>
<h2 id="creating-a-new-project"><a class="header" href="#creating-a-new-project">Creating a new project</a></h2>
<p>Let's create a new project and compare it with the Hello World example in previous chapter.</p>
<p>To create a project you should create a directory for your project :</p>
Expand Down
28 changes: 14 additions & 14 deletions docs/latest/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h1 class="menu-title">Hascal Documentation</h1>
<main>
<h1 id="overview"><a class="header" href="#overview">Overview</a></h1>
<h2 id="introduction"><a class="header" href="#introduction">Introduction</a></h2>
<p><a href="https://hascal.github.io">Hascal</a> is a general-purpose open source programming language that makes it easy to build simple,optimal, reliable, and efficient software. More features of Hascal :</p>
<p><strong><a href="https://hascal.github.io">Hascal</a></strong> is a general purpose and open source programming language designed to build optimal, maintainable, reliable, and efficient software. More features of Hascal :</p>
<ul>
<li><input disabled="" type="checkbox" checked=""/>
Easy to use and easy to learn</li>
Expand Down Expand Up @@ -194,24 +194,24 @@ <h2 id="windows-users"><a class="header" href="#windows-users">Windows Users</a>
&gt; make windows
</code></pre>
<p><em><strong>Now your Hascal compiler is ready to use in <code>dist</code> folder, you can add it to <code>$PATH</code>.</strong></em></p>
<p><strong>NOTE</strong>: <strong>The latest version of Hascal should always be used, older versions have bugs when running binary versions of Hascal.</strong></p>
<p><strong>NOTE</strong>: <strong>The latest version of Hascal should always be used. Old versions have bugs when running binary versions of Hascal.</strong></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="hello-world"><a class="header" href="#hello-world">Hello World!</a></h1>
<p>Now that you have successfully installed Haskall, let's write our first program with it. You will write a program that prints <code>Hello World!</code> on the terminal.</p>
<p>Now that you have successfully installed Hascal, let's write our first program with it. You will write a program that prints <code>Hello World!</code> on the terminal.</p>
<h2 id="creating-a-project-directory"><a class="header" href="#creating-a-project-directory">Creating a project directory</a></h2>
<p>You can wite your hascal programs every where but We suggest that you create a directory for your project.</p>
<p>First create a directory in your home directory(or anywhere else):</p>
<p>You can write your Hascal programs every where but, we suggest that you create a directory for your project.</p>
<p>At first, create a directory in your home directory(or anywhere else):</p>
<pre><code>mkdir hello_world
cd hello_wrold
</code></pre>
<h2 id="writing-the-code"><a class="header" href="#writing-the-code">Writing the code</a></h2>
<p>Next make a new file and name it <code>main.has</code>. Hascal files should end with <code>.has</code> extension.</p>
<p>Now open your code editor(If you are using <code>vscode</code> install hascal extension for better coding from <a href="https://github.com/hascal/vscode">this link</a>) and write following code in <code>main.has</code> :</p>
<p>Now open your code editor (If you are using <code>vscode</code> install hascal extension for better coding from <a href="https://github.com/hascal/vscode">this link</a>) and write the following code in <code>main.has</code> :</p>
<pre><code class="language-typescript">function main() : int {
print(&quot;Hello World!&quot;)
return 0
}
</code></pre>
<p>Save the file, and back to terminal and enter following command to build your program :</p>
<p>Save the file, and return to the terminal and enter the following command to build your program :</p>
<pre><code>hascal main.has
</code></pre>
<p>Now run the generated excutable file :</p>
Expand All @@ -224,26 +224,26 @@ <h2 id="writing-the-code"><a class="header" href="#writing-the-code">Writing the
</code></pre>
<p>Congratulations - you just wrote and executed your first Hascal program!</p>
<h2 id="reviewing-the-code"><a class="header" href="#reviewing-the-code">Reviewing the code</a></h2>
<p>Let's review the our simple program. Here's the first piece of the program :</p>
<p>Let's review our simple program. Here's the first piece of the program:</p>
<pre><code class="language-typescript">function main() : int {

}
</code></pre>
<p>These lines defines a function that returns an integer number. The <code>main</code> function is the entry point of your program and it always should return <code>int</code>(an integer), if there were parameters, they would go inside the parentheses, <code>()</code>.</p>
<p>Also, note function statements should be in <code>{}</code> and you write function codes inside <code>{}</code>.</p>
<p>These lines define a function that returns an integer number. The <code>main</code> function is the entry point of your program and it should always return <code>int</code>(an integer). If there were parameters, they would go inside the parentheses, <code>()</code>.</p>
<p>Also, note that function statements should be in <code>{}</code> and you can write function codes inside <code>{}</code>.</p>
<p>Inside the <code>main</code> function is the following code :</p>
<pre><code class="language-typescript">print(&quot;Hello World!&quot;)
</code></pre>
<p>This code print the passed arguments, you can pass more parameters :</p>
<pre><code class="language-typescript">print(&quot;Hello World!&quot;,42,3.14)
</code></pre>
<p>After the calling <code>print</code> command is following statemetn :</p>
<p>After the calling <code>print</code> command, there is the following statement :</p>
<pre><code class="language-typescript">return 0
</code></pre>
<p>It returns <code>0</code> at end of the function, every function that returns a value(declared with <code>:</code> after <code>()</code> in function declaration) should return a value with mentioned type. </p>
<p>Returning the <code>0</code> value in main function tell the OS that your program executed successfully.</p>
<p>It returns <code>0</code> at the end of the function, every function that returns a value(declared with <code>:</code> after <code>()</code> in a function declaration) should return a value corresponding to the type.</p>
<p>Returning the <code>0</code> value in main function tell the OS that your program has executed successfully.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="project-manager"><a class="header" href="#project-manager">Project Manager</a></h1>
<p>Hascal has a builtin build system and project manager. This tool builds and runs your project, installs dependencies.</p>
<p>Hascal has a builtin build system and project manager. This tool builds and runs your project, and installs dependencies.</p>
<h2 id="creating-a-new-project"><a class="header" href="#creating-a-new-project">Creating a new project</a></h2>
<p>Let's create a new project and compare it with the Hello World example in previous chapter.</p>
<p>To create a project you should create a directory for your project :</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/latest/searchindex.json

Large diffs are not rendered by default.

0 comments on commit 4ee83da

Please sign in to comment.