Skip to content

Commit 5276b1c

Browse files
sreichholfStephan Reichholf
authored andcommitted
Update README
1 parent 0e2d41d commit 5276b1c

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README renamed to README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
1. Licensing
2-
Whenever you think about adding your stuff to schwerkraft, you should
1+
# Licensing
2+
Whenever you think about adding your stuff to github.com/opendreambox, you should
33
think about the license you want to apply to your code/resources.
44
It is a common agreement in the open source world to put a file called
55
LICENSE or COPYING into the root directory of your project and/or to add
@@ -8,13 +8,13 @@ the license text to the head of all your sources.
88
Please always take care not to violate the license of code you didn't
99
actually write yourself but got somewhere else.
1010

11-
2. Adding new plugins
12-
Everyone is welcome to publish their plugins and/or skins on schwerkraft.
13-
Every plugin and skin added to schwerkraft can be added to the
11+
# Adding new plugins or skins
12+
Everyone is welcome to publish their plugins and/or skins on github.com/opendreambox.
13+
Every plugin and skin added to github.com/opendreambox can be added to the
1414
official build system and will usually be available via the official
1515
experimental mirrors within a day.
1616

17-
2.1 Directory structures and paths
17+
## Directory structures and paths
1818
Before you start you should have a rough look at existing directory
1919
structures and structure your things accordingly.
2020
Please do not use any absolute paths, neither in the Makefiles nor in a plugin.
@@ -26,8 +26,8 @@ In enimga2 and any of its plugins you could use eEnv.resolve() to do the same.
2626
In addition you can use enigma2's Tools.Directories.resolveFilename()
2727
in conjunction with the according SCOPE_* constants.
2828

29-
2.2 Add your plugin to the build system
30-
Basically everything on schwerkraft will automatically be built on a
29+
## Add your plugin to the build system
30+
Basically everything on github.com/opendreambox will automatically be built on a
3131
daily basis. This is done using "autotools" in an openembedded build environment.
3232
If you want to set up your own openembedded you can take a look at
3333
http://opendreambox.org/ (you will need a Linux system for that).
@@ -47,7 +47,7 @@ finding and fixing things a lot easier.
4747
If you are not familiar with Makefiles or configure.ac, just try to take a look
4848
at existing content. You'll find lots of examples in enigma2-plugins.
4949

50-
2.3 Become the maintainer of what you created
50+
## Become the maintainer of what you created
5151
If you're adding an enigma2-plugin, please also consider adding a proper
5252
maintainer.info for your plugin.
5353
A maintainer.info just contains two things: the mail address of the author
@@ -56,10 +56,11 @@ It enables users to send a crashlog to the actual maintainer of a plugin
5656
that seems to have caused a crash.
5757

5858
Example:
59+
```
5960
6061
WebInterface
61-
62-
3. Changing other people's plugins or skins
62+
```
63+
# Changing other people's plugins or skins
6364
Before changing anything in someone else's sources, please try to contact
6465
him/her and discuss the things you want to change.
6566
Sometimes people have good reasons why they don't want particular things to
@@ -69,14 +70,12 @@ Sometimes though, the original author doesn't maintain a plugin anymore.
6970
So if you have any fixes or enhancements for some existing plugin that
7071
doesn't seem to be maintained anymore or you cannot get any feedback from
7172
the original author, you can always go ahead and commit your changes.
72-
As schwerkraft uses git, you can undo your changes at any time, if you want
73+
As github.com/opendreambox uses git, you can undo your changes at any time, if you want
7374
or have to.
7475
But again, please check that whatever you're going to change doesn't violate
7576
any licenses!
7677

77-
4. Getting in contact
78+
# Getting in contact
7879
If you want to get in contact with some of the people that created and
79-
maintain the projects on schwerkraft.elitedvb.net you are always welcome
80+
maintain the projects on github.com/opendreambox you are always welcome
8081
to join us on #enigma2 in the freenode.net IRC network.
81-
82-

0 commit comments

Comments
 (0)