mmk2410/rangitaki
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated README.md

Browse source
This commit is contained in:
mmk2410 2015-08-22 10:27:51 +02:00
parent c703df1deb
commit f40a680877
1 changed files with 6 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -2,18 +2,15 @@
Rangitaki is a simple to use and easy to configure blogging engine, written in PHP and it has absolutely no database dependencies. Rangitaki is a simple to use and easy to configure blogging engine, written in PHP and it has absolutely no database dependencies.
##Important - Please read [Website](https://marcel-kapfer.de/rangitaki)
[About](https://marcel-kapfer.de/rangitaki/about)
Right now there are two versions in development. The series 0.2 and everything higher. Version 0.2 is ready for production while everything higher are development releases and not ready for productive use. I recommend you to use the latest Version of the 0.2 series which you can find in the branch "Series-0.2" or wait until 1.0 is release, which will be at the end of July. The latest version is 0.2.2 which is available in the releases section. This readme is for the version >= 0.3. [Documentation](https://marcel-kapfer.de/rangitaki/docs)
[Quick Starting Guide](https://marcel-kapfer.de/rangitaki/docs/quick)
Read also this [blog article](https://marcel-kapfer.de/rangitaki/blog/?article=2015-03-29-21-34-About-the-Future-of-pBlog) which explains the reasons behind this step.
## What is it? ## What is it?
My goal for Rangitaki was (and still is) to create a blogging engine without database dependencies (so you don't have to create database and tables and all that stuff) which is extremely easy and fast to setup and to learn. Rangitaki doesn't require any knowledge concerning PHP, JavaScript, HTML or CSS. You just need to know, how to upload something to your web server. There is also no need to compile anything, you just have to fill out twelve setting properties and then you can start writing your articles. My goal for Rangitaki was (and still is) to create a blogging engine without database dependencies (so you don't have to create database and tables and all that stuff) which is extremely easy and fast to setup and to learn. Rangitaki doesn't require any knowledge concerning PHP, JavaScript, HTML or CSS. You just need to know, how to upload something to your web server. There is also no need to compile anything, you just have to fill out twelve setting properties and then you can start writing your articles.
For version 1.0 I will provide a documentation and a quick-start guide.
## So, what can it do? ## So, what can it do?
- Post writing in Markdown with a few keywords for the title, tags, date and the author (all optional) - Post writing in Markdown with a few keywords for the title, tags, date and the author (all optional)
@ -45,7 +42,7 @@ Yes. Rangitaki has a theme support which makes it easy to customize your blog co
The RCC (Rangitaki Control Center) is still in development and features right now only a post upload. If you wanna use it you have to change file permissions manually on your server and also add some values to different text files. The RCC (Rangitaki Control Center) is still in development and features right now only a post upload. If you wanna use it you have to change file permissions manually on your server and also add some values to different text files.
A documentation for RCC will be available with the Rangitaki 1.0 release. [Read the RCC documentation](https://marcel-kapfer.de/rangitaki/docs/rcc)
## Where can I see an example? ## Where can I see an example?
@ -56,33 +53,19 @@ A documentation for RCC will be available with the Rangitaki 1.0 release.
Would you like to see your Rangitaki blog here? Write me a message at [marcelmichaelkapfer@yahoo.co.nz](mailto:marcelmichaelkapfer@yahoo.co.nz) Would you like to see your Rangitaki blog here? Write me a message at [marcelmichaelkapfer@yahoo.co.nz](mailto:marcelmichaelkapfer@yahoo.co.nz)
## What do you see in your crystal ball?
I'm thinking of releasing a Rangitaki PHP framework later this year, so you can simply build your own blog.
I also planning to port the engine and the framework into JavaScript. Which would be good for people without a PHP server and it would also be possible to create a Polymer element.
## Used Library ## Used Library
- For converting the Markdown blog articles into HTML code I use [Parsedown](http://parsedown.org) - For converting the Markdown blog articles into HTML code I use [Parsedown](http://parsedown.org)
## Contributing ## Contributing
### Code
1. Fork it 1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`) 2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`) 3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`) 4. Push to the branch (`git push origin my-new-feature`)
5. Create New Pull Request 5. Create New Pull Request
### Localization Read also the [contributing documentation](https://marcel-kapfer.de/rangitaki/docs/contrib)
Contribute localization files just like code. If you don't have a GitHub account you can also send me the files to [marcelmichaelkapfer@yahoo.co.nz](mailto:marcelmichaelkapfer@yahoo.co.nz)
### Team
If you want to join the Rangitaki "team" and are willing to invest some time into this project, then contact me over mail ([marcelmichaelkapfer@yahoo.co.nz](mailto:marcelmichaelkapfer@yahoo.co.nz)), Google+ ([+MarcelMichaelKapfer](https://plus.google.com/+MarcelMichaelKapfer) or Twitter ([@mmk2410](https://twitter.com/mmk2410)) and we can talk about that.
## Social ## Social