opennamu
====
![Python 3.5 or later Required](https://img.shields.io/badge/python-%3E%3D%203.5-blue.svg)

opennamu is a Python-based wiki engine. You can use opennamu by installing Python and its dependency modules, and you can modify the code yourself to create more specialized wikis.

 * [(README for korean)](./readme-ko.md)

### Index
 * [Getting Started](#getting-started)
 * [Clone](#clone)
 * [Contribute](#contribute)
 * [License](#license)
 * [Authors](#authors)
 * [Etc.](#etc)

# Getting Started

# Clone
You can clone this repository by entering the following command at the terminal (command prompt):
## Stable
 * `git clone -b stable https://github.com/2du/opennamu.git`

## Beta
 * `git clone -b master https://github.com/2du/opennamu.git`

# Contribute
opennamu may have some untested bugs. Your use of opennamu and bug discovery will help develop opennamu.
[Create Issues](https://github.com/2du/opennamu/issues/new)

opennamu is open source project. Add new features and request pull requests. 
[Create Pull Requests](https://github.com/2du/opennamu/compare)

# Lisence
opennamu is protected by [BSD 3-Clause License](./LICNESE). Please refer to the documentation for details.

## External Projects
 * Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672) CC 3.0 BY
 * Syntax highlighting [highlightjs](https://highlightjs.org/)
 * Numerical expression [MathJax](https://www.mathjax.org/)

# Authors
 * [Reference](https://github.com/2DU/opennamu/graphs/contributors)

## Special Thanks
 * [Team Croatia](https://github.com/TeamCroatia)
 * Basix
 * Efrit
 * Other chat rooms

# Etc.
`set.json` is a configuration file that stores some local settings.
 * db = Database name

If you delete `set.json`, you can create a new one again.

[Test Server](http://namu.ml/)

Owner rights are granted to the first registor.