updated part of documentation
This commit is contained in:
Ace
parent
2bfc9a2b4d
commit
4d65c9b601
31
docs/about.md
Normal file
31
docs/about.md
Normal file
@ -0,0 +1,31 @@
|
||||
# About Inkycal
|
||||
<img align="center" src="https://raw.githubusercontent.com/aceisace/Inky-Calendar/development/Gallery/logo.png" width="800">
|
||||
|
||||
Inkycal is a python3 software for selected E-Paper displays.
|
||||
It's open-source (non-commercially), fully modular, user friendly and even runs
|
||||
well even on the Raspberry Pi Zero. Inkycal even has a web-UI which takes
|
||||
care of adding your details! No more editing files, Yay :partying_face:
|
||||
|
||||
The main idea behind Inkycal was to create a dashboard that blends in well
|
||||
in it's environment and shows you all information without you having to look
|
||||
them up. Several built-in modules help you stay organised by:
|
||||
* providing the weather forecast for the full week or next few hours
|
||||
* getting the latest news from ATOM/RSS feeds
|
||||
* showing your iCalendar agenda, which may be syncronised with your phone
|
||||
* showing a monthly Calendar which may also show events synced with Google etc.
|
||||
* fetch some jokes form the web to help you smile :)
|
||||
|
||||
What's more? It's compatible with third party modules, if something is missing,
|
||||
you can write your own module and share it with the community.
|
||||
|
||||
Inkycal has a friendly and helpful community on Discord in case you're in
|
||||
a pinch setting up Inkycal. Noobs welcome too of course!
|
||||
|
||||
Inkycal is developed mainly by [aceisace](https://github.com/aceisace) - a
|
||||
university student and a few other developers in their free time.
|
||||
Open source means we work for nothing, but it doesn't mean we don't need
|
||||
anything. We invest a large amount of time, effort and coffee to develop
|
||||
Inkycal.
|
||||
|
||||
Please support Inkycal via a **[DONATION](https://www.paypal.me/SaadNaseer)**
|
||||
to help us keep this project alive. Thank You!
|
||||
@ -1,20 +0,0 @@
|
||||
About this project
|
||||
==================
|
||||
.. image:: ../Gallery/logo.png
|
||||
:align: center
|
||||
|
||||
Inkycal is a software to render the following on selected ePaper displays:
|
||||
* Events (from your iCalendar)
|
||||
* Weather (using the openweathermap API)
|
||||
* News (via RSS/Atom feeds)
|
||||
|
||||
It's aim is to help out with organization in daily-life by providing all the info you need
|
||||
without having to check it up.
|
||||
|
||||
Inkycal is free to use for anyone (non-commercially) and open-source.
|
||||
|
||||
It is mainly developed by `aceisace <https://github.com/aceisace>`_ and a few other developers
|
||||
in their free time.
|
||||
|
||||
Developing Inkycal requires a fairly large amount of coffee and free time. We work in our free time for offer you the best software we can write. Please consider a `DONATION <https://www.paypal.me/SaadNaseer>`_ to help keep this project
|
||||
well-maintained |:person_bowing:| .
|
||||
13
docs/conf.py
13
docs/conf.py
@ -31,7 +31,8 @@ release = '2.0.0'
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinxemoji.sphinxemoji',
|
||||
'sphinx_rtd_theme']
|
||||
'sphinx_rtd_theme', 'recommonmark']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
@ -46,9 +47,15 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "sphinx_rtd_theme" # html_theme = 'classic' # removed classic theme
|
||||
html_theme = "sphinx_rtd_theme" # html_theme = 'classic'
|
||||
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
'.txt': 'markdown',
|
||||
'.md': 'markdown',
|
||||
}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = ['_static'] # no static content required
|
||||
# html_static_path = ['_static']
|
||||
|
||||
@ -16,8 +16,6 @@ Inkycal documentation
|
||||
about
|
||||
quickstart
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
||||
20
docs/quickstart.md
Normal file
20
docs/quickstart.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Quickstart
|
||||
<img align="center" src="https://raw.githubusercontent.com/aceisace/Inky-Calendar/development/Gallery/logo.png" width="800">
|
||||
|
||||
## Installing Inkycal
|
||||
|
||||
Install inkycal directly via the github repo:
|
||||
|
||||
```bash
|
||||
# clone the repo
|
||||
git clone -b release/2.0.0 https://github.com/aceisace/Inky-Calendar Inkycal
|
||||
|
||||
# go to downloaded repo folder
|
||||
cd Inkycal
|
||||
|
||||
# install Inkycal
|
||||
pip3 install -e ./
|
||||
```
|
||||
|
||||
## Creating settings file
|
||||
coming soon
|
||||
@ -1,25 +0,0 @@
|
||||
.. image:: ../Gallery/logo.png
|
||||
:align: center
|
||||
|
||||
Quickstart
|
||||
===========
|
||||
|
||||
Installing Inkycal
|
||||
------------------
|
||||
Install inkycal directly via the github repo:
|
||||
|
||||
.. code-block:: sh
|
||||
:linenos:
|
||||
|
||||
# clone the repo
|
||||
git clone -b release/2.0.0 https://github.com/aceisace/Inky-Calendar Inkycal
|
||||
|
||||
# go to downloaded repo folder
|
||||
cd Inkycal
|
||||
|
||||
# install Inkycal
|
||||
pip3 install -e ./
|
||||
|
||||
Creating settings file
|
||||
----------------------
|
||||
coming soon
|
||||
Loading…
Reference in New Issue
Block a user