README
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 06 Oct 2017 16:59:10 +0200
branch3.25
changeset 12205 a97cdb531a75
parent 12141 29d032bb70d8
child 12262 282bc6fb50fd
permissions -rw-r--r--
[test] Pin some test dependencies We currently have CI failures because cubes used as test dependencies have been updated to new-style cube layout. To avoid this, pin them to previous released. Those dependencies should be removed but in the mean time this should be enough (and backported in all active branches).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
     1
CubicWeb semantic web framework
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
     2
===============================
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
     3
5024
9e718abe3fde add egg support with dependencies auto-installation
Alain Leufroy <alain.leufroy@logilab.fr>
parents: 2562
diff changeset
     4
CubicWeb is a entities / relations based knowledge management system
9e718abe3fde add egg support with dependencies auto-installation
Alain Leufroy <alain.leufroy@logilab.fr>
parents: 2562
diff changeset
     5
developped at Logilab.
9e718abe3fde add egg support with dependencies auto-installation
Alain Leufroy <alain.leufroy@logilab.fr>
parents: 2562
diff changeset
     6
9e718abe3fde add egg support with dependencies auto-installation
Alain Leufroy <alain.leufroy@logilab.fr>
parents: 2562
diff changeset
     7
This package contains:
7741
45251e611209 [doc] fix ReST in README file (make pypi happier)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7613
diff changeset
     8
45251e611209 [doc] fix ReST in README file (make pypi happier)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7613
diff changeset
     9
- a repository server
45251e611209 [doc] fix ReST in README file (make pypi happier)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7613
diff changeset
    10
- a RQL command line client to the repository
45251e611209 [doc] fix ReST in README file (make pypi happier)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7613
diff changeset
    11
- an adaptative modpython interface to the server
45251e611209 [doc] fix ReST in README file (make pypi happier)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7613
diff changeset
    12
- a bunch of other management tools
5024
9e718abe3fde add egg support with dependencies auto-installation
Alain Leufroy <alain.leufroy@logilab.fr>
parents: 2562
diff changeset
    13
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    14
Install
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    15
-------
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    16
12105
566075b02ce5 Refer to cubicweb.readthedocs.io in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11132
diff changeset
    17
More details at https://cubicweb.readthedocs.io/en/3.25/book/admin/setup
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    18
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    19
Getting started
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    20
---------------
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    21
7741
45251e611209 [doc] fix ReST in README file (make pypi happier)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7613
diff changeset
    22
Execute::
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    23
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    24
 apt-get install cubicweb cubicweb-dev cubicweb-blog
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    25
 cubicweb-ctl create blog myblog
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    26
 cubicweb-ctl start -D myblog
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    27
 sensible-browser http://localhost:8080/
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    28
12105
566075b02ce5 Refer to cubicweb.readthedocs.io in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11132
diff changeset
    29
Details at https://cubicweb.readthedocs.io/en/3.25/tutorials/base/blog-in-five-minutes
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    30
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    31
Documentation
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    32
-------------
2562
dd76d0f88796 [doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 0
diff changeset
    33
12105
566075b02ce5 Refer to cubicweb.readthedocs.io in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11132
diff changeset
    34
Look in the doc/ subdirectory or read https://cubicweb.readthedocs.io/en/3.25/
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    35
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    36
12106
eeb2b2ec1928 Make entypo link a true URL in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12105
diff changeset
    37
CubicWeb includes the Entypo pictograms by Daniel Bruce — http://www.entypo.com
12141
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    38
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    39
Contributing
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    40
------------
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    41
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    42
Patches should be submitted by email at the cubicweb-devel@lists.cubicweb.org
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    43
mailing list in order to get reviewed by project integrators or any community
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    44
member.
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    45
The simplest way of send patches is to use the ``hg email`` command available
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    46
through the *patchbomb* extension of Mercurial. Preferably, patches should be
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    47
*in the message body* of emails. When submitting a revised version of a patch
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    48
series, a prefix indicating the iteration number ``<n>`` of the series should
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    49
be added to email subject prefixes; this can be achieved by specifying a
29d032bb70d8 Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12106
diff changeset
    50
``--flag v<n>`` option to ``hg email`` command.