Neverlose.cc Lua API snippets generator

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

Getting Started

Prerequisites

First of all you need to install:

• python3

sudo apt-get install python3-pip

Installation

1. Clone the repo

git clone https://github.com/neverlosecc/snippets-generator.git --recursive

2. Open cloned repo

cd snippets-generator

3. Install python libraries

sudo pip3 install -r requirements.txt

4. Enter your repo owner and repo name of documentation to config.json

{
    "owner": "YOUR_REPO_OWNER",
    "repo": "YOUR_REPO_NAME"
}

Usage

1. Exit from project folder

cd ../

2. Run python project

python3 -m snippets-generator

3. Check out output.json

cd snippets-generator
cat output.json | tail

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Arsenii Esenin - [email protected] - es3n1n#3573

Project Link: https://github.com/neverlosecc/snippets-generator