|
@@ -12,71 +12,41 @@ openNAMU is a Python-based wiki engine. You can use openNAMU by installing Pytho
|
|
|
* [Clone](#clone)
|
|
* [Clone](#clone)
|
|
|
* [Contribute](#contribute)
|
|
* [Contribute](#contribute)
|
|
|
* [License](#license)
|
|
* [License](#license)
|
|
|
- * [Authors](#authors)
|
|
|
|
|
* [Etc.](#etc)
|
|
* [Etc.](#etc)
|
|
|
|
|
|
|
|
## Getting Started
|
|
## Getting Started
|
|
|
openNAMU is based upon Python, and it requires a Python environment.
|
|
openNAMU is based upon Python, and it requires a Python environment.
|
|
|
|
|
|
|
|
-### Download Releases
|
|
|
|
|
-Download the [release version of openNAMU](https://github.com/2du/openNAMU/releases), and unzip the file. It is also possible to download releases by [cloning this repository](#Clone).
|
|
|
|
|
|
|
+[Here](http://2du.pythonanywhere.com) you can see the guide.
|
|
|
|
|
|
|
|
-### Install Modules
|
|
|
|
|
-Windows
|
|
|
|
|
-```
|
|
|
|
|
-pip install -r requirements.txt
|
|
|
|
|
-```
|
|
|
|
|
-
|
|
|
|
|
-Linux
|
|
|
|
|
-```
|
|
|
|
|
-pip3 install -r requirements.txt
|
|
|
|
|
-```
|
|
|
|
|
-## Launching Application
|
|
|
|
|
-Windows
|
|
|
|
|
-```
|
|
|
|
|
-python app.py
|
|
|
|
|
-```
|
|
|
|
|
-
|
|
|
|
|
-Linux
|
|
|
|
|
-```
|
|
|
|
|
-python3 app.py
|
|
|
|
|
-```
|
|
|
|
|
-
|
|
|
|
|
-## Publishing Application
|
|
|
|
|
-
|
|
|
|
|
-# Clone
|
|
|
|
|
|
|
+## Clone
|
|
|
You can clone this repository by entering the following command at the terminal (command prompt):
|
|
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`
|
|
* `git clone -b stable https://github.com/2du/openNAMU.git`
|
|
|
-
|
|
|
|
|
-## Beta
|
|
|
|
|
* `git clone -b master https://github.com/2du/openNAMU.git`
|
|
* `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)
|
|
|
|
|
|
|
+## 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 a complete open source project. Add new features and create pull requests.
|
|
|
|
|
-[[Create Pull Requests]](https://github.com/2du/openNAMU/compare)
|
|
|
|
|
|
|
+openNAMU is a complete open source project. Add new features and create pull requests. [(Create Pull Requests)](https://github.com/2du/openNAMU/compare)
|
|
|
|
|
|
|
|
-# Lisence
|
|
|
|
|
|
|
+## Lisence
|
|
|
openNAMU is protected by [BSD 3-Clause License](./LICNESE). Please refer to the documentation for details.
|
|
openNAMU is protected by [BSD 3-Clause License](./LICNESE). Please refer to the documentation for details.
|
|
|
|
|
|
|
|
-## External Projects
|
|
|
|
|
|
|
+### External Projects
|
|
|
* Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672)
|
|
* Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672)
|
|
|
* Syntax highlighting [highlightjs](https://highlightjs.org/)
|
|
* Syntax highlighting [highlightjs](https://highlightjs.org/)
|
|
|
* Numerical expression [MathJax](https://www.mathjax.org/)
|
|
* Numerical expression [MathJax](https://www.mathjax.org/)
|
|
|
* Handling Keyboard Shortcuts [shortcut.js](http://www.openjs.com/scripts/events/keyboard_shortcuts/)
|
|
* Handling Keyboard Shortcuts [shortcut.js](http://www.openjs.com/scripts/events/keyboard_shortcuts/)
|
|
|
|
|
|
|
|
-# Authors
|
|
|
|
|
|
|
+### Authors
|
|
|
* [Reference](https://github.com/2DU/openNAMU/graphs/contributors)
|
|
* [Reference](https://github.com/2DU/openNAMU/graphs/contributors)
|
|
|
|
|
|
|
|
-## Special Thanks
|
|
|
|
|
|
|
+### Special Thanks
|
|
|
* [Team Croatia](https://github.com/TeamCroatia)
|
|
* [Team Croatia](https://github.com/TeamCroatia)
|
|
|
* Basix
|
|
* Basix
|
|
|
* Efrit
|
|
* Efrit
|
|
|
* Other chat rooms
|
|
* Other chat rooms
|
|
|
|
|
|
|
|
-# Etc.
|
|
|
|
|
|
|
+## Etc.
|
|
|
* Owner rights are granted to the first registor.
|
|
* Owner rights are granted to the first registor.
|
|
|
* [Test Server](http://2du.pythonanywhere.com)
|
|
* [Test Server](http://2du.pythonanywhere.com)
|