Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 1.74 KB

QUICKSTART.md

File metadata and controls

87 lines (60 loc) · 1.74 KB

Project Start Guide (version 0.2)

Bash

BSD

Quick Start Guide Introduction

Project Name: RillHost-BashScript-Template Project

This document is intended to provide:
1.1 Brief Picture of this Project
1.2 How to Run this Project
1.3 Project Reference (License & CopyRight)

Basic Environment

2.1 Development Environment

Project Tested as:

  • CentOS 8 / Fedora 33
  • Bash 5.x

2.2 Stage Environment
2.3 Production Environment

Project Building

3.1 get source code from github (installation 1)

mkdir ~/Projects/Github.com/
cd ~/Project/Github.com/
git clone https://github.com/czhou-dev-2020/BashScript.git

3.2 setup local database (installation 2)

Not yet

3.3 running project on localhost

[czhou@localhost ~]$ cd ~/Projects/Github.com/BashScript/src/Template
[czhou@localhost BashScript]$ ./RillHost-BashScript-Template.sh

3.4 project start demo

[czhou@localhost BashScript]$ ./RillHost-BashScript-Template.sh 
hello world!
Hello cranez
Bash version: 5.0.17(1)-release

Code Structure

4.1 Main
screen picture 1
4.2 Test
screen picture 2

Test Case (Optional)

5.1 Test Case 1
5.2 Test Case 2

Project Reference

  • See DESIGN for project design document
  • See COMPONENTS for project components (official websites reference)

Contributors

  • ISV 1: Crane Zhou
  • ISV 2: xxx xxx
  • API Vendor 1:
  • API Vendor 2:

License & CopyRight

This Project is released under the terms of the BSD license.
See LICENSE for more information or see:
https://opensource.org/licenses/BSD-3-Clause.