author | Denis Laxalde <denis.laxalde@logilab.fr> |
Wed, 15 May 2019 15:44:35 +0200 | |
branch | 3.26 |
changeset 12599 | 0357c05f203e |
parent 12375 | e7221f2123e6 |
child 12532 | 38004d09d178 |
permissions | -rw-r--r-- |
2562
dd76d0f88796
[doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
0
diff
changeset
|
1 |
CubicWeb semantic web framework |
0 | 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 | 14 |
Install |
15 |
------- |
|
2562
dd76d0f88796
[doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
0
diff
changeset
|
16 |
|
12262
282bc6fb50fd
Link to "3.26" docs in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12141
diff
changeset
|
17 |
More details at https://cubicweb.readthedocs.io/en/3.26/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 | 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 |
|
12262
282bc6fb50fd
Link to "3.26" docs in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12141
diff
changeset
|
29 |
Details at https://cubicweb.readthedocs.io/en/3.26/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 |
|
12372
392aa430bf96
[README] point to logilab's jenkins in tests section
Laurent Peuch <cortex@worlddomination.be>
parents:
12262
diff
changeset
|
31 |
You can also look at the latest builds on Logilab's jenkins: |
392aa430bf96
[README] point to logilab's jenkins in tests section
Laurent Peuch <cortex@worlddomination.be>
parents:
12262
diff
changeset
|
32 |
https://jenkins.logilab.org/ |
392aa430bf96
[README] point to logilab's jenkins in tests section
Laurent Peuch <cortex@worlddomination.be>
parents:
12262
diff
changeset
|
33 |
|
0 | 34 |
Documentation |
35 |
------------- |
|
2562
dd76d0f88796
[doc] #120075 quickstart (was proposed structure)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
0
diff
changeset
|
36 |
|
12262
282bc6fb50fd
Link to "3.26" docs in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12141
diff
changeset
|
37 |
Look in the doc/ subdirectory or read https://cubicweb.readthedocs.io/en/3.26/ |
0 | 38 |
|
39 |
||
12106
eeb2b2ec1928
Make entypo link a true URL in README
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12105
diff
changeset
|
40 |
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
|
41 |
|
29d032bb70d8
Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12106
diff
changeset
|
42 |
Contributing |
29d032bb70d8
Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12106
diff
changeset
|
43 |
------------ |
29d032bb70d8
Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12106
diff
changeset
|
44 |
|
29d032bb70d8
Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12106
diff
changeset
|
45 |
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
|
46 |
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
|
47 |
member. |
29d032bb70d8
Add a "Contributing" section to README with patch submission guidelines
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
12106
diff
changeset
|
48 |
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
|
49 |
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
|
50 |
*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
|
51 |
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
|
52 |
be added to email subject prefixes; this can be achieved by specifying a |
12373
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
53 |
``--flag v<n>`` option to ``hg email`` command. If needed you can also use the |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
54 |
--in-reply-to option. |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
55 |
|
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
56 |
Examples: |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
57 |
|
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
58 |
hg email --to cubicweb-devel@lists.cubicweb.org --intro -r <start>::<end> |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
59 |
hg email --flag V2 --to cubicweb-devel@lists.cubicweb.org -r <start>::<end> |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
60 |
|
12375
e7221f2123e6
[README] point to xmpp room for contributors
Laurent Peuch <cortex@worlddomination.be>
parents:
12373
diff
changeset
|
61 |
If you have any questions you can also come on Logilab's public XMPP room using |
e7221f2123e6
[README] point to xmpp room for contributors
Laurent Peuch <cortex@worlddomination.be>
parents:
12373
diff
changeset
|
62 |
a XMPP client: public@conference.jabber.logilab.org |
e7221f2123e6
[README] point to xmpp room for contributors
Laurent Peuch <cortex@worlddomination.be>
parents:
12373
diff
changeset
|
63 |
|
12373
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
64 |
Mailing list: https://lists.cubicweb.org/mailman/listinfo/cubicweb-devel |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
65 |
Patchbomb extension: https://www.mercurial-scm.org/wiki/PatchbombExtension |
e7ef70b3a0eb
[README] improve contribution section with links and command examples
Laurent Peuch <cortex@worlddomination.be>
parents:
12372
diff
changeset
|
66 |
Good practice on sending email patches: https://www.mercurial-scm.org/wiki/ContributingChanges#Emailing_patches |