Commit 8d1d3e9a authored by kosheo's avatar kosheo

Added readme. Added robots.txt and sitemap. Updated help.

parent af8c7ced
*.md eol=lf
*.js eol=lf
*.pug eol=lf
*.less eol=lf
*.yml eol=lf
*.xml eol=lf
# clcalc
Online command line style calculator
https://clcalc.net
[![Build Status](https://travis-ci.org/ovk/clcalc.svg?branch=master)](https://travis-ci.org/ovk/clcalc)
[![Coverage Status](https://coveralls.io/repos/github/ovk/clcalc/badge.svg?branch=master)](https://coveralls.io/github/ovk/clcalc?branch=master)
[![Maintenance](https://img.shields.io/maintenance/yes/2017.svg)]()
[![license](https://img.shields.io/github/license/ovk/clcalc.svg)]()
# Summary
Cl Calc is an open-source, lightweight, command-line style online calculator. It is built as fully static website and hosted through GitHub Pages (`docs` directory in the repository contains actual website). As the result of being completely static, Cl Calc performs all calculations on the client side.
Cl Calc uses [MathJS](http://mathjs.org) library for expression parsing and evaluation; thus, all MathJS features are available in Cl Calc.
# Features
Some of the Cl Calc features include:
- High precision (long arithmetic) math expression evaluation.
- Variety of built-in mathematical, scientific, programming and utility functions. This includes algebra, arithmetic, combinatorics, probability, matrix, statistics, trigonometry, logical, encoding functions and more.
- User defined variables and functions.
- Many built-in datatypes, including complex numbers, fractions, vectors, matrices and colors.
- Base64 Encoding, Unicode, hexadecimal and binary numbers support.
- Persistent links to store or share your calculations.
- Pretty-printing expressions with TeX.
# Documentation
Documentation is available [here](https://clcalc.net/help.html).
If you are completely new to Cl Calc you may want to check this small [Quick Start](https://clcalc.net/help.html#quickstart) guide.
# Build
Get the sources from the GitHub:
```
git clone https://github.com/ovk/clcalc.git
cd clcalc
```
Install the dependencies:
```
npm install
```
To build the production version of the Cl Calc website:
```
npm run-script dist
```
This will create `dist` directory with generated HTML, CSS, JavaScript files and images.
For development build do:
```
npm run-script dev
```
In development build `dist` directory will also contain source maps for JavaScript files and HTML files won't be minified. In addition to that, a web server will be started hosting `dist` contents at http://localhost:8080. It watches for changes and automatically re-runs necessary tasks to regenerate HTML, CSS or JavaScript as needed.
# Test
Make sure the dependencies are installed:
```
npm install
```
Also make sure you've run either production or development build first. See *Build* section above.
Now you can simply run:
```
npm test
```
to run the tests. This will execute tests in Chrome and Firefox in parallel by default. You can adjust this behavior in `karma.conf.js` file.
This will also generate code coverage data available under `coverage` directory. To see it navigate to either `Firefox...` or `Chrome...` subfolder inside `coverage` folder and open `lcov-report/index.html`.
# License
Cl Calc is licensed under [MIT](https://github.com/ovk/clcalc/blob/master/LICENSE) license.
This diff is collapsed.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1"><meta name="description" content="Minimalist online command-line calculator with variables, functions and more"><title>Cl Calc: Online Command-Line Calculator</title><link href="favicon.ico" rel="shortcut icon"><link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" rel="stylesheet" type="text/css" crossorigin="anonymous"><link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,400i,700" rel="stylesheet" type="text/css"><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.terminal/1.11.0/css/jquery.terminal.min.css" integrity="sha256-NPnczI0KjCueVIbIZBIjffajQholjsUnhVe4sQgL80U=" rel="stylesheet" type="text/css" crossorigin="anonymous"><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.3/katex.min.css" integrity="sha256-kAbX9Z5ZMhjo34PRGEMc7RiueevlbmDilvUt1NsZGAI=" rel="stylesheet" type="text/css" crossorigin="anonymous"><!-- Create link (expression or log) popower template--><script type="text/html" id="template-create-link-popover"><div class="input-group"><input class="form-control" type="text" readonly="true" value="{link}"><span class="input-group-btn"><button class="btn btn-primary copy-link-to-clipboard" type="button"><span class="glyphicon glyphicon-copy"></span>&nbsp;Copy</button></span></div></script><!-- Create link (expression or log) popower template without 'Copy' button--><script type="text/html" id="template-create-link-popover-no-copy"><input class="form-control" type="text" readonly="true" value="{link}"></script><!-- Create expression link button template--><script type="text/html" id="template-create-expression-link-button"><div style="float: right;"><a class="create-expression-link-button" href="javascript:void(0)" role="button"><span class="glyphicon glyphicon-link"></span></a></div></script><link href="main.css" rel="stylesheet" type="text/css"></head><body><nav class="navbar navbar-default navbar-fixed-top"><div class="container-fluid"><div class="navbar-header"><a class="navbar-brand" href="/"><img alt="Cl Calc" src="./brand.png" width="20" height="20">Cl Calc</a></div><div><ul class="nav navbar-nav navbar-right"><li> <a href="https://github.com/ovk/clcalc"> <img alt="GitHub Page" src="./github.png" width="20" height="20">GitHub</a></li></ul></div></div></nav><div class="sidebar"><a href="javascript:void(0)" id="generate-log-link-button"><div class="round-button" title="Create link with the current calculator content" data-toggle="tooltip" data-placement="bottom" data-container="body" data-delay="{ &quot;show&quot;: 800, &quot;hide&quot;: 100 }"><span class="glyphicon glyphicon-link"></span></div></a><a href="javascript:void(0)" id="toggle-tex-panel-button"><div class="round-button" title="Toggle TeX panel" data-toggle="tooltip" data-placement="bottom" data-container="body" data-delay="{ &quot;show&quot;: 800, &quot;hide&quot;: 100 }"><span class="glyphicon glyphicon-text-size"></span></div></a><a href="/help.html" target="_blank"><div class="round-button" title="Open help page" data-toggle="tooltip" data-placement="bottom" data-container="body" data-delay="{ &quot;show&quot;: 800, &quot;hide&quot;: 100 }"><span class="texticon">?</span></div></a></div><div class="content-panel"><div class="content-wrapper"><div class="console-wrapper"><div class="console-wrapper-inner"><div class="console-panel"></div></div></div><div class="tex-wrapper"><div class="tex-wrapper-inner"><div class="tex-panel"></div></div></div></div></div><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-mousewheel/3.1.13/jquery.mousewheel.min.js" integrity="sha256-jnOjDTXIPqall8M0MyTSt98JetJuZ7Yu+1Jm7hLTF7U=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.terminal/1.11.0/js/jquery.terminal.min.js" integrity="sha256-Qm1Nw4js01hUsHFCa8xirKnSZeRXR8uNgbAKwjhn9mA=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjs/3.18.0/math.min.js" integrity="sha256-SqWLfbThKpf8OmjlWA0nUcT7/LmdX9cXUk2ti/I1I1o=" crossorigin="anonymous"></script><script src="calc.js"></script></body></html>
\ No newline at end of file
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1"><meta name="description" content="Advanced online command-line style calculator with mathematical, scientific, programming, utility functions and more"><title>Cl Calc: Online Command-Line Calculator</title><link href="favicon.ico" rel="shortcut icon"><link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" rel="stylesheet" type="text/css" crossorigin="anonymous"><link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,400i,700" rel="stylesheet" type="text/css"><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.terminal/1.11.0/css/jquery.terminal.min.css" integrity="sha256-NPnczI0KjCueVIbIZBIjffajQholjsUnhVe4sQgL80U=" rel="stylesheet" type="text/css" crossorigin="anonymous"><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.3/katex.min.css" integrity="sha256-kAbX9Z5ZMhjo34PRGEMc7RiueevlbmDilvUt1NsZGAI=" rel="stylesheet" type="text/css" crossorigin="anonymous"><!-- Create link (expression or log) popower template--><script type="text/html" id="template-create-link-popover"><div class="input-group"><input class="form-control" type="text" readonly="true" value="{link}"><span class="input-group-btn"><button class="btn btn-primary copy-link-to-clipboard" type="button"><span class="glyphicon glyphicon-copy"></span>&nbsp;Copy</button></span></div></script><!-- Create link (expression or log) popower template without 'Copy' button--><script type="text/html" id="template-create-link-popover-no-copy"><input class="form-control" type="text" readonly="true" value="{link}"></script><!-- Create expression link button template--><script type="text/html" id="template-create-expression-link-button"><div style="float: right;"><a class="create-expression-link-button" href="javascript:void(0)" role="button"><span class="glyphicon glyphicon-link"></span></a></div></script><link href="main.css" rel="stylesheet" type="text/css"></head><body><nav class="navbar navbar-default navbar-fixed-top"><div class="container-fluid"><div class="navbar-header"><a class="navbar-brand" href="/"><img alt="Cl Calc" src="./brand.png" width="20" height="20">Cl Calc</a></div><div><ul class="nav navbar-nav navbar-right"><li> <a href="https://github.com/ovk/clcalc"> <img alt="GitHub Page" src="./github.png" width="20" height="20">GitHub</a></li></ul></div></div></nav><div class="sidebar"><a href="javascript:void(0)" id="generate-log-link-button"><div class="round-button" title="Create link with the current calculator content" data-toggle="tooltip" data-placement="bottom" data-container="body" data-delay="{ &quot;show&quot;: 800, &quot;hide&quot;: 100 }"><span class="glyphicon glyphicon-link"></span></div></a><a href="javascript:void(0)" id="toggle-tex-panel-button"><div class="round-button" title="Toggle TeX panel" data-toggle="tooltip" data-placement="bottom" data-container="body" data-delay="{ &quot;show&quot;: 800, &quot;hide&quot;: 100 }"><span class="glyphicon glyphicon-text-size"></span></div></a><a href="/help.html" target="_blank"><div class="round-button" title="Open help page" data-toggle="tooltip" data-placement="bottom" data-container="body" data-delay="{ &quot;show&quot;: 800, &quot;hide&quot;: 100 }"><span class="texticon">?</span></div></a></div><div class="content-panel"><div class="content-wrapper"><div class="console-wrapper"><div class="console-wrapper-inner"><div class="console-panel"></div></div></div><div class="tex-wrapper"><div class="tex-wrapper-inner"><div class="tex-panel"></div></div></div></div></div><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-mousewheel/3.1.13/jquery.mousewheel.min.js" integrity="sha256-jnOjDTXIPqall8M0MyTSt98JetJuZ7Yu+1Jm7hLTF7U=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.terminal/1.11.0/js/jquery.terminal.min.js" integrity="sha256-Qm1Nw4js01hUsHFCa8xirKnSZeRXR8uNgbAKwjhn9mA=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjs/3.18.0/math.min.js" integrity="sha256-SqWLfbThKpf8OmjlWA0nUcT7/LmdX9cXUk2ti/I1I1o=" crossorigin="anonymous"></script><script src="calc.js"></script></body></html>
\ No newline at end of file
User-agent: *
Disallow:
Sitemap: https://clcalc.net/sitemap.xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://clcalc.net/</loc>
<lastmod>2017-12-23</lastmod>
<priority>1.00</priority>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://clcalc.net/help.html</loc>
<lastmod>2017-12-23</lastmod>
<priority>0.80</priority>
<changefreq>weekly</changefreq>
</url>
</urlset>
......@@ -81,7 +81,17 @@ block content
// Overview
h1(id = 'overview') Overview
p Cl Calc is an open-source, lightweight, command-line style on-line calculator. While it has clean and simple interface, it is quite powerful due to the fact that its core is based on the #[a(href = 'mathjs.org') MathJS] library. Cl Calc offers high precision math expression evaluation, variety of built-in mathematical, programming and utility functions, ability to define custom variables and functions, many built-in datatypes (real numbers, complex numbers, vectors, matrices, colors etc.) and much more.
p Cl Calc is an open-source, lightweight, command-line style online calculator. While it has clean and simple interface, it is quite powerful due to the fact that its core is based on the #[a(href = 'mathjs.org') MathJS] library.
p Some of the Cl Calc features include:
ul
li High precision (long arithmetic) math expression evaluation.
li Variety of built-in mathematical, scientific, programming and utility functions. This includes algebra, arithmetic, combinatorics, probability, matrix, statistics, trigonometry, logical, encoding functions and more.
li User defined variables and functions.
li Many built-in datatypes, including complex numbers, fractions, vectors, matrices and colors.
li Base64 Encoding, Unicode, hexadecimal and binary numbers support.
li Persistent links to store or share your calculations.
li Pretty-printing expressions with TeX.
p Cl Calc is written purely in JavaScript and it evaluates all expressions directly in your browser. This means that your data is never sent to the server for processing or storage.
......
doctype html
html(lang = 'en')
include config.pug
block variables
- var title = title || '';
head
meta(charset = 'utf-8')
meta(http-equiv = 'X-UA-Compatible', content = 'IE=edge')
meta(name = 'viewport', content = 'width=device-width, initial-scale=1')
meta(name = 'description', content = 'Minimalist online command-line calculator with variables, functions and more')
title Cl Calc: #{title}
link(href = 'favicon.ico', rel = 'shortcut icon')
link(href = lib.bootstrap.css.url, integrity = lib.bootstrap.css.integrity, rel = 'stylesheet', type = 'text/css', crossorigin = 'anonymous')
link(href = 'https://fonts.googleapis.com/css?family=Roboto+Mono:400,400i,700', rel = 'stylesheet', type = 'text/css')
script(src = lib.jquery.js.url, integrity = lib.jquery.js.integrity, crossorigin = 'anonymous')
script(src = lib.bootstrap.js.url, integrity = lib.bootstrap.js.integrity, crossorigin = 'anonymous')
block inject_head
link(href = 'main.css', rel = 'stylesheet', type = 'text/css')
body
nav.navbar.navbar-default.navbar-fixed-top
div.container-fluid
div.navbar-header
a.navbar-brand(href = '/')
img(alt = 'Cl Calc', src = './brand.png', width = 20, height = 20)
| Cl Calc
div
ul.nav.navbar-nav.navbar-right
li(class = (page === 'help') ? 'active' : '')
a(href = 'https://github.com/ovk/clcalc')
img(alt = 'GitHub Page', src = './github.png', width = 20, height = 20)
| GitHub
block content
block scripts
doctype html
html(lang = 'en')
include config.pug
block variables
- var title = title || '';
head
meta(charset = 'utf-8')
meta(http-equiv = 'X-UA-Compatible', content = 'IE=edge')
meta(name = 'viewport', content = 'width=device-width, initial-scale=1')
meta(name = 'description', content = 'Advanced online command-line style calculator with mathematical, scientific, programming, utility functions and more')
title Cl Calc: #{title}
link(href = 'favicon.ico', rel = 'shortcut icon')
link(href = lib.bootstrap.css.url, integrity = lib.bootstrap.css.integrity, rel = 'stylesheet', type = 'text/css', crossorigin = 'anonymous')
link(href = 'https://fonts.googleapis.com/css?family=Roboto+Mono:400,400i,700', rel = 'stylesheet', type = 'text/css')
script(src = lib.jquery.js.url, integrity = lib.jquery.js.integrity, crossorigin = 'anonymous')
script(src = lib.bootstrap.js.url, integrity = lib.bootstrap.js.integrity, crossorigin = 'anonymous')
block inject_head
link(href = 'main.css', rel = 'stylesheet', type = 'text/css')
body
nav.navbar.navbar-default.navbar-fixed-top
div.container-fluid
div.navbar-header
a.navbar-brand(href = '/')
img(alt = 'Cl Calc', src = './brand.png', width = 20, height = 20)
| Cl Calc
div
ul.nav.navbar-nav.navbar-right
li(class = (page === 'help') ? 'active' : '')
a(href = 'https://github.com/ovk/clcalc')
img(alt = 'GitHub Page', src = './github.png', width = 20, height = 20)
| GitHub
block content
block scripts
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment