File tree Expand file tree Collapse file tree 1 file changed +57
-0
lines changed Expand file tree Collapse file tree 1 file changed +57
-0
lines changed Original file line number Diff line number Diff line change 1+ # Project Name
2+
3+ (short, 1-3 sentenced, description of the project)
4+
5+ ## Features
6+
7+ This project framework provides the following features:
8+
9+ * Feature 1
10+ * Feature 2
11+ * ...
12+
13+ ## Getting Started
14+
15+ ### Prerequisites
16+
17+ (ideally very short, if any)
18+
19+ - OS
20+ - Library version
21+ - ...
22+
23+ ### Installation
24+
25+ (ideally very short)
26+
27+ - npm install [ package name]
28+ - mvn install
29+ - ...
30+
31+ ### Quickstart
32+ (Add steps to get up and running quickly)
33+
34+ 1 . git clone [ repository clone url]
35+ 2 . cd [ respository name]
36+ 3 . ...
37+
38+
39+ ## Demo
40+
41+ A demo app is included to show how to use the project.
42+
43+ To run the demo, follow these steps:
44+
45+ (Add steps to start up the demo)
46+
47+ 1 .
48+ 2 .
49+ 3 .
50+
51+ ## Resources
52+
53+ (Any additional resources or related projects)
54+
55+ - Link to supporting information
56+ - Link to similar sample
57+ - ...
You can’t perform that action at this time.
0 commit comments