Initial structure for documentation
This commit is contained in:
parent
2f7576cddc
commit
2ae4f56fca
9 changed files with 215 additions and 3 deletions
48
README.rst
48
README.rst
|
@ -1,4 +1,50 @@
|
|||
Nerv Tales Network
|
||||
==================
|
||||
|
||||
Authoring tool, library, accessibility, adaptation, copyright exemption, risk, pdca, documents and accounting management system.
|
||||
Nerv Tales Network is a free software to manage all
|
||||
aspects about books. It fits needs of writers,
|
||||
editors, adaptation to people with specific needs,
|
||||
libraries, book shops, online libraries and book
|
||||
shops, museums, schools, ebooks distributors and
|
||||
readers. It manages:
|
||||
|
||||
- Accessibility
|
||||
- Documents
|
||||
- Communication
|
||||
- Stocks and items
|
||||
- Projects
|
||||
- Accounting
|
||||
- Risks and objectives
|
||||
- Learning and documentary surveillance
|
||||
- On-line services
|
||||
- Help and consultancy
|
||||
- High security and confidentiality
|
||||
- Synchronization
|
||||
|
||||
.. note::
|
||||
|
||||
You can also use Nerv Tales Network on other
|
||||
applications if it fits your needs.
|
||||
|
||||
.. danger::
|
||||
|
||||
Even if Nerv Tales Network have enough features
|
||||
and security systems, it can't be used in the
|
||||
following cases:
|
||||
|
||||
- classified documents management and storage;
|
||||
- health management except for entities
|
||||
authorized to deliver adaptations of work of
|
||||
art;
|
||||
- any activity where the software need an
|
||||
agreement, a certification, an habilitation,
|
||||
an audit or other administrative stuff.
|
||||
|
||||
However, you can use Nerv Tales Network in these
|
||||
cases if you pass all legal steps by yourself.
|
||||
You can't ask help to the community or to
|
||||
Nerv Project ASBL in these cases, and you must
|
||||
conform to the EUPL-1.2 licence.
|
||||
|
||||
All works, the software, all plugins and
|
||||
documentations are under the EUPL-1.2 licence.
|
||||
|
|
34
docs/source/about.rst
Normal file
34
docs/source/about.rst
Normal file
|
@ -0,0 +1,34 @@
|
|||
About Nerv Tales Network
|
||||
========================
|
||||
|
||||
Nerv Project ASBL develops Nerv Tales Network for
|
||||
it's internal usage and all authorized entities for
|
||||
work adaptations. We want to give an open-source
|
||||
and free of charge software to help all people and
|
||||
foundations.
|
||||
|
||||
|
||||
====================== ====================
|
||||
Details Nerv Project ASBL
|
||||
====================== ====================
|
||||
Contact contact AT nerv-project.eu
|
||||
Status ASBL
|
||||
Adress | Rue Longue 27 Bte K10
|
||||
| 1420 Eigenbrakel
|
||||
| Belgium
|
||||
Phone +32 (0)2 319 888 0
|
||||
Enterprise 0756.741.342
|
||||
VAT BE0756741342
|
||||
Editor number KBR 15066
|
||||
Publication Nerv Project ASBL
|
||||
Production Nerv Project ASBL
|
||||
Webmaster Nerv Project ASBL
|
||||
Author Nerv Project ASBL except expressly set out
|
||||
Video Nerv Project ASBL
|
||||
Hosting IT4Freedom
|
||||
IBAN BE02 7512 1068 4040
|
||||
BIC AXABBE22
|
||||
====================== ====================
|
||||
|
||||
Please contact us if you want to donate, as we
|
||||
need some informations to create your invoice.
|
5
docs/source/administration/index.rst
Normal file
5
docs/source/administration/index.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
Administration manual
|
||||
=====================
|
||||
|
||||
Nothing here. Sorry, we're working on the first
|
||||
version of software.
|
12
docs/source/contributing.rst
Normal file
12
docs/source/contributing.rst
Normal file
|
@ -0,0 +1,12 @@
|
|||
Contributing
|
||||
============
|
||||
|
||||
How to contribute ?
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Where's the source code ?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Can I contribute if I'm not a developer ?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
5
docs/source/developing/index.rst
Normal file
5
docs/source/developing/index.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
Developing manual
|
||||
=================
|
||||
|
||||
Nothing here. Sorry, we're working on the first
|
||||
version of software.
|
|
@ -1,7 +1,102 @@
|
|||
Nerv Tales Network Documentation
|
||||
################################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
Nerv Tales Network is a free software to manage all
|
||||
aspects about books. It fits needs of writers,
|
||||
editors, adaptation to people with specific needs,
|
||||
libraries, book shops, online libraries and book
|
||||
shops, museums, schools, ebooks distributors and
|
||||
readers. It manages:
|
||||
|
||||
- Accessibility
|
||||
- Documents
|
||||
- Communication
|
||||
- Stocks and items
|
||||
- Projects
|
||||
- Accounting
|
||||
- Risks and objectives
|
||||
- Learning and documentary surveillance
|
||||
- On-line services
|
||||
- Help and consultancy
|
||||
- High security and confidentiality
|
||||
- Synchronization
|
||||
|
||||
|
||||
|
||||
- writing environment;
|
||||
- ultra-accessible reader with text, audio, sign
|
||||
language, very helpful resumes and other;
|
||||
- tools to adapt works of art;
|
||||
- emails, instant messaging with XMPP;
|
||||
- phone calls;
|
||||
- contacts;
|
||||
- file and documents with sharing features;
|
||||
- websites and blogs;
|
||||
- internal and external documentation;
|
||||
- accounting, purchases and invoicing;
|
||||
- stocks and inventory;
|
||||
- membership, customers and suppliers;
|
||||
- point of sale and self-service PoS for sales and loans;
|
||||
- events and calendar with private and public access
|
||||
and online registration;
|
||||
- learning management and elearning;
|
||||
- rooms;
|
||||
- projects with public funds;
|
||||
- risk and PDCA management;
|
||||
- quality requirements;
|
||||
- social and environmental impacts;
|
||||
- GDPR complaints, confidentiality;
|
||||
- human resources;
|
||||
- tickets and contact forms;
|
||||
- advanced licenses and copyright exemptions, free
|
||||
DRM and encryption;
|
||||
- e-shop and downloading works of art;
|
||||
- and a lot more.
|
||||
|
||||
.. note::
|
||||
|
||||
You can also use Nerv Tales Network on other
|
||||
applications if it fits your needs.
|
||||
|
||||
.. danger::
|
||||
|
||||
Even if Nerv Tales Network have enough features
|
||||
and security systems, it can't be used in the
|
||||
following cases:
|
||||
|
||||
- classified documents management and storage;
|
||||
- health management except for entities
|
||||
authorized to deliver adaptations of work of
|
||||
art;
|
||||
- any activity where the software need an
|
||||
agreement, a certification, an habilitation,
|
||||
an audit or other administrative stuff.
|
||||
|
||||
However, you can use Nerv Tales Network in these
|
||||
cases if you pass all legal steps by yourself.
|
||||
You can't ask help to the community or to
|
||||
Nerv Project ASBL in these cases, and you must
|
||||
conform to the EUPL-1.2 licence.
|
||||
|
||||
All works, the software, all plugins and
|
||||
documentations are under the EUPL-1.2 licence.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Community
|
||||
|
||||
about
|
||||
roadmap
|
||||
contributing
|
||||
history
|
||||
|
||||
Please select the documentation you want to consult.
|
||||
|
||||
.. toctree::
|
||||
:caption: Documentation
|
||||
:maxdepth: 1
|
||||
|
||||
user/index
|
||||
administration/index
|
||||
developing/index
|
||||
specifications/index
|
||||
|
|
2
docs/source/roadmap.rst
Normal file
2
docs/source/roadmap.rst
Normal file
|
@ -0,0 +1,2 @@
|
|||
Roadmap
|
||||
=======
|
8
docs/source/specifications/index.rst
Normal file
8
docs/source/specifications/index.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
Specifications
|
||||
==============
|
||||
|
||||
You'll find all specifications for future features
|
||||
here. The documentation is removed from this
|
||||
document when the feature is implemented, and
|
||||
rewritten into developing, administration and user
|
||||
manuals.
|
5
docs/source/user/index.rst
Normal file
5
docs/source/user/index.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
User manual
|
||||
===========
|
||||
|
||||
Nothing here. Sorry, we're working on the first
|
||||
version of software.
|
Loading…
Reference in a new issue