Page MenuHome
Create Task
Maniphest T63559

Minimal readme
Closed, ResolvedPublicTO DO
Actions

Description

While https://developer.blender.org doesn't display a prominent readme,
other 3rd party hosting services do (github/gitlab/bitbucket).

People may stumble on these sites (searching blender git here, 2 of the top 4 results link to github for eg),
in these cases it's nice if they're directed to official development channels and have some basic useful information.

Suggested text (taken from blender.org, roughly following https://github.com/KDE/krita as a template).

While other sections could be added the intention is to link elsewhere and not include too many details here - adding maintenance burden.

P951 readme.rst
1
2Blender
3=======
4
5Blender is the free and open source 3D creation suite.
6It supports the entirety of the 3D pipeline—modeling,
7rigging, animation, simulation, rendering, compositing and motion tracking and video editing.
8
9Project Pages
10-------------
11
12- `Website <http://www.blender.org>`__
13- `Reference Manual <https://docs.blender.org/manual/en/latest/index.html>`__
14- `Development & Issue Tracker <https://developer.blender.org>`__
15- `Discussion Forum <https://devtalk.blender.org>`__
16
17
18Development Notes and Build Instructions
19----------------------------------------
20
21- `Developer Introduction <https://wiki.blender.org/wiki/Developer_Intro>`__
22- `Building Blender <https://wiki.blender.org/wiki/Building_Blender>`__
23
24
25License
26-------
27
28Blender as a whole is licensed under the GNU Public License, Version 3.
29Individual files may have a different, but compatible license.

Screenshot from github:

Related Objects

Event Timeline

Campbell Barton (campbellbarton) lowered the priority of this task from 90 to Normal.Apr 13 2019, 9:53 AM
Campbell Barton (campbellbarton) created this task.
Campbell Barton (campbellbarton) updated the task description. (Show Details)
Campbell Barton (campbellbarton) added a project: BF Blender.Apr 13 2019, 10:04 AM
Campbell Barton (campbellbarton) edited a custom field.
Campbell Barton (campbellbarton) added subscribers: Dalai Felinto (dfelinto), Brecht Van Lommel (brecht), Bastien Montagne (mont29), Sergey Sharybin (sergey).
Campbell Barton (campbellbarton) updated the task description. (Show Details)Apr 13 2019, 10:07 AM
Campbell Barton (campbellbarton) updated the task description. (Show Details)Apr 13 2019, 10:14 AM
Campbell Barton (campbellbarton) updated the task description. (Show Details)Apr 13 2019, 10:24 AM
Campbell Barton (campbellbarton) changed the task status from Unknown Status to Resolved.Apr 13 2019, 10:56 AM
Campbell Barton (campbellbarton) claimed this task.

Went over this w/ @Bastien Montagne (mont29), committed rBa43b373c429c16a66788791e66ec6e7338a85f0e

Any minor changes can be committed directly.

Brecht Van Lommel (brecht) added a comment.Apr 13 2019, 1:33 PM

Seems fine generally. I suggest list some development links separately, and make the distinction between user and dev forums like this:

Project Pages
-------------

- `Website <http://www.blender.org>`__
- `Reference Manual <https://docs.blender.org/manual/en/latest/index.html>`__
- `User Community <https://www.blender.org/community/>`__

Development
-----------

- `Build Instructions <https://wiki.blender.org/wiki/Building_Blender>`__
- `Code Review & Bug Tracker <https://developer.blender.org>`__
- `Developer Forum <https://devtalk.blender.org>`__
- `Developer Documentation <https://wiki.blender.org>`__
Campbell Barton (campbellbarton) added a comment.EditedApr 13 2019, 2:47 PM

@Brecht Van Lommel (brecht) LGTM, committed rB70cbd0a6bdb99001c779412771d9b1ae28f32017

See https://github.com/sobotka/blender (readme on github).