diff --git a/README.md b/README.md index 185b04e..4b37990 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# Nightmare 😈 +# Nightmare 😈 The Nightmare Project. -## Introduction -Nightmare is a tool for both multiple command and web service develop by Python. This project is my first program design by Python. So I try to use Python to written some useful tools for both Windows and Linux. Now it contains many functions. I will continue to contribute to this project about new feature and make it more funny and useful. +## Introduction +Nightmare is a tool for both multiple commands and web services developed in Python. This project is my first program designed in Python. I aimed to use Python to write some useful tools for both Windows and Linux. It now includes many features, and I will continue contributing to this project by adding new features and making it more fun and useful. -The project name is Nightmare. It stand for many mysterious things in our mind. This is a mysterious phenomenon that we cannot reasonably explain, so wonderful and fascinating. +The project is named Nightmare, symbolizing many mysterious things in our minds. It represents a phenomenon that we cannot easily explain—something so wonderful and fascinating. -## Installation and usage -Install Python3 and download package from [https://www.python.org](https://www.python.org) +## Installation and Usage +Install Python 3 and download the package from [https://www.python.org](https://www.python.org) - | OS | Architecture | Version | Binary | - | ------------- |:-------------:|:-------:| :------------------------: | - | Windows | amd64 | 3.7.5 ▲ | python3.7.5 windows/amd64 | - | Linux | adm64 | 3.7.5 ▲ | python3.7.5 linux/amd64 | - | Linux | arm | 3.7.5 ▲ | python3.7.5 linux/arm | - -#### Use Git to clone this project - `git clone https://github.com/gorgeousbubble/nightmare.git` - -#### Install dependencies - There are many dependencies we used in this project, we recommend you to install those packages before build the project. You can use pip to install those packages for native deployment. For containerized nightmare, you don't need worry about that, when you build docker image, it will be automatic install and deploy. We will continue update those package which nightmare project rely on, here is the list. - -#### Build native or container - You can use `python main.py` to run application. Use `-h` or `--help` option to help you find out the introduction of these function. You can also use `build.bat` to build nightmare application in Windows OS. \ No newline at end of file +| OS | Architecture | Version | Binary | +| ------------- |:-------------:|:-------:| :------------------------: | +| Windows | amd64 | 3.7.5 ▲ | python3.7.5 windows/amd64 | +| Linux | amd64 | 3.7.5 ▲ | python3.7.5 linux/amd64 | +| Linux | arm | 3.7.5 ▲ | python3.7.5 linux/arm | + +#### Use Git to Clone This Project +`git clone https://github.com/gorgeousbubble/nightmare.git` + +#### Install Dependencies +There are several dependencies used in this project. We recommend installing these packages before building the project. You can use `pip` to install the packages for native deployment. For containerized Nightmare, you don't need to worry about this—when you build the Docker image, the dependencies will be automatically installed and deployed. We will continue updating the list of packages that Nightmare relies on. Here is the current list. + +#### Build Native or Container +You can use `python main.py` to run the application. Use the `-h` or `--help` option to get an introduction to these functions. You can also use `build.bat` to build the Nightmare application on Windows OS.