mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-20 21:18:32 +02:00
228 lines
7.5 KiB
HTML
Executable file
228 lines
7.5 KiB
HTML
Executable file
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<meta name="author" content="Manuel Ebert">
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Quickstart - jrnl</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet">
|
|
<link href="../assets/theme.css" rel="stylesheet">
|
|
<link href="../assets/highlight.css" rel="stylesheet">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Quickstart";
|
|
var mkdocs_page_input_path = "installation.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="../js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> jrnl</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../overview/">Overview</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
|
|
<a class="current" href="./">Quickstart</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#getting-started">Getting started</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#installation">Installation</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#quickstart">Quickstart</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../usage/">Basic Usage</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../encryption/">Encryption</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../export/">Import and Export</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../advanced/">Advanced Usage</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../recipes/">Recipes</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">jrnl</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Quickstart</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/jrnl-org/jrnl/edit/master/docs/installation.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="getting-started">Getting started</h1>
|
|
<h2 id="installation">Installation</h2>
|
|
<p>On OS X, the easiest way to install <em>jrnl</em> is using
|
|
<a href="http://brew.sh/">Homebrew</a></p>
|
|
<pre><code class="sh">brew install jrnl
|
|
</code></pre>
|
|
|
|
<p>On other platforms, install <em>jrnl</em> using pip</p>
|
|
<pre><code class="sh">pip install jrnl
|
|
</code></pre>
|
|
|
|
<p>Or, if you want the option to encrypt your journal,</p>
|
|
<pre><code class="sh">pip install jrnl[encrypted]
|
|
</code></pre>
|
|
|
|
<p>to install the dependencies for encrypting journals as well.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Installing the encryption library, <code>pycrypto</code>, requires a <code>gcc</code> compiler. For this reason, jrnl will
|
|
not install <code>pycrypto</code> unless explicitly told so like this. You can <a href="https://www.dlitz.net/software/pycrypto/">install PyCrypto manually</a>
|
|
first or install it with <code>pip install pycrypto</code> if you have a <code>gcc</code> compiler.
|
|
Also note that when using zsh, the correct syntax is <code>pip install "jrnl[encrypted]"</code> (note the quotes).</p>
|
|
</div>
|
|
<p>The first time you run <code>jrnl</code> you will be asked where your journal file
|
|
should be created and whether you wish to encrypt it.</p>
|
|
<h2 id="quickstart">Quickstart</h2>
|
|
<p>to make a new entry, just type</p>
|
|
<pre><code class="sh">jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.
|
|
</code></pre>
|
|
|
|
<p>and hit return. <code>yesterday:</code> will be interpreted as a time stamp.
|
|
Everything until the first sentence mark (<code>.?!:</code>) will be interpreted as
|
|
the title, the rest as the body. In your journal file, the result will
|
|
look like this:</p>
|
|
<pre><code class="output">2012-03-29 09:00 Called in sick.
|
|
Used the time to clean the house and spent 4h on writing my book.
|
|
</code></pre>
|
|
|
|
<p>If you just call <code>jrnl</code>, you will be prompted to compose your entry -
|
|
but you can also configure <em>jrnl</em> to use your external editor.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../usage/" class="btn btn-neutral float-right" title="Basic Usage">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../overview/" class="btn btn-neutral" title="Overview"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
|
|
<span><a href="../overview/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../usage/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
|
|
</body>
|
|
</html>
|