README.rst

Project 9

copyright:	© SnooeyNET
license:	CC0
moduleauthor:	Seongsu Yoon <[email protected]>

Summary

Just Joke project for kar...ulgi

How to Run?

Commons

You must install Python 3 and required pip packages. In development, make virturlenv environment is good choice for you.

Windows

1. Check if you installed Python 3.6 or upper
2. Clone this git repository and open it Command Prompt
3. If you want to make virtualenv, follow below command:

# make virtualenv on env folder of repository folder
> python3 -m venv env

# run
> env\Scripts\activate

4. Launch

> python main.py

macOS/Linux

1. Check if you installed Python 3.6 or upper
2. Clone this git repository and open it at Terminal
3. If you want to make virtualenv, follow below command:

# make virtualenv on env directory of repository directory
$ python3 -m venv ./env

# run by bash shell
$ source env/bin/activate

4. Launch

$ python main.py

Documentation

Commons

This package using Sphinx for auto documentation.

Windows

1. follow below command:

# first run
> env\Scripts\sphinx-quickstart.exe

2. after work - it skips what exist files, make seperated files

> env\Scripts\sphinx-apidoc.exe -F -o docs . --separate

3. use command if you want to build html document

> env\Scripts\sphinx-build.exe -b html docs docs/_build/html

macOS/Linux

1. follow below command:

# first run
$ ./env/bin/sphinx-quickstart

2. after work - it skips what exist files, make seperated files

$ ./env/bin/sphinx-apidoc -F -o docs . --separate

3. use command if you want to build html document

$ ./env/bin/sphinx-build -b html docs docs/_build/html

Configuration

not yet

See also

not yet