Update readme for public
This commit is contained in:
29
README.md
29
README.md
@@ -1,12 +1,21 @@
|
|||||||
# NextBestNetwork, a Bootstrap based skin for MediaWiki
|
# NextBestNetwork, a Bootstrap based skin for MediaWiki
|
||||||
|
|
||||||
NextBestNetwork is a skin for **[MediaWiki](http://mediawiki.org/)** (1.35+) based on
|
NextBestNetwork is a skin for **[MediaWiki](http://mediawiki.org/)** (1.35+) based on
|
||||||
|
**[Bootstrap](http://getbootstrap.com/)** (v5.3).
|
||||||
|
|
||||||
|
You can find an instance of NextBestNetwork in action at **[wiki.specnext.dev](http://wiki.specnext.dev/)**
|
||||||
|
|
||||||
|
The original project's README now follows...
|
||||||
|
|
||||||
|
# Tweeki, a Bootstrap based skin for MediaWiki
|
||||||
|
|
||||||
|
Tweeki is a skin for **[MediaWiki](http://mediawiki.org/)** (1.35+) based on
|
||||||
**[Bootstrap](http://getbootstrap.com/)** (v4.6.2). It tries to implement as
|
**[Bootstrap](http://getbootstrap.com/)** (v4.6.2). It tries to implement as
|
||||||
much of Bootstrap's functionality as possible, allowing to use it very easily and with
|
much of Bootstrap's functionality as possible, allowing to use it very easily and with
|
||||||
very reduced markup, and features many configuration options.
|
very reduced markup, and features many configuration options.
|
||||||
|
|
||||||
You can find an instance of NextBestNetwork in action and the extended documentation at the
|
You can find an instance of Tweeki in action and the extended documentation at the
|
||||||
project's website **[nextbestnetwork.kollabor.at](http://nextbestnetwork.kollabor.at/)**
|
project's website **[tweeki.kollabor.at](http://tweeki.kollabor.at/)**
|
||||||
|
|
||||||
|
|
||||||
## Get started
|
## Get started
|
||||||
@@ -20,37 +29,37 @@ project's website **[nextbestnetwork.kollabor.at](http://nextbestnetwork.kollabo
|
|||||||
2. Clone the repository:
|
2. Clone the repository:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/thaider/NextBestNetwork NextBestNetwork
|
git clone https://github.com/thaider/Tweeki Tweeki
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Add the following to `LocalSettings.php`:
|
3. Add the following to `LocalSettings.php`:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
wfLoadSkin( 'NextBestNetwork' );
|
wfLoadSkin( 'Tweeki' );
|
||||||
$wgDefaultSkin = "nextbestnetwork";
|
$wgDefaultSkin = "tweeki";
|
||||||
```
|
```
|
||||||
|
|
||||||
## Optional configuration
|
## Optional configuration
|
||||||
|
|
||||||
Please refer to the project's website **[nextbestnetwork.kollabor.at](http://nextbestnetwork.kollabor.at/)**
|
Please refer to the project's website **[tweeki.kollabor.at](http://tweeki.kollabor.at/)**
|
||||||
for further information about configuration and customization options.
|
for further information about configuration and customization options.
|
||||||
|
|
||||||
|
|
||||||
## Licensing, Copying, Usage
|
## Licensing, Copying, Usage
|
||||||
|
|
||||||
NextBestNetwork is open source, and built on open source projects.
|
Tweeki is open source, and built on open source projects.
|
||||||
|
|
||||||
Please check out the [LICENSE file](https://github.com/thaider/NextBestNetwork/blob/master/LICENSE)
|
Please check out the [LICENSE file](https://github.com/thaider/Tweeki/blob/master/LICENSE)
|
||||||
for details.
|
for details.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Suggestions for improvements, ideally in the form of pull request, are always warmly welcome.
|
Suggestions for improvements, ideally in the form of pull request, are always warmly welcome.
|
||||||
|
|
||||||
In case you aren't able to implement some new feature that you would like to see in NextBestNetwork,
|
In case you aren't able to implement some new feature that you would like to see in Tweeki,
|
||||||
consider hiring one of these people:
|
consider hiring one of these people:
|
||||||
|
|
||||||
* Tobias Haider (NextBestNetwork's maintainer)
|
* Tobias Haider (Tweeki's maintainer)
|
||||||
* ...
|
* ...
|
||||||
|
|
||||||
If you're a developer and want to be put on this list, just drop me a note...
|
If you're a developer and want to be put on this list, just drop me a note...
|
||||||
Reference in New Issue
Block a user