IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

READEME_simple.md 2.15 KB
Newer Older
Joshua Gay's avatar
Joshua Gay committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
Place this file in the top level of your project's git repo and rename it "README.md"

# Project Title

One paragraph short description

Packages
The following repo contains open source materials intended for
reference by the IEEE 1076 standard when approved and published.

## License

All source code files in this repository are subject to the
following copyright and licensing terms.

Copyright 2020 NAME or GROUP-NAME

See the LICENSE file distributed with this work for copyright and
licensing information, the AUTHORS file for a list of copyright
holders, and the CONTRIBUTORS file for the list of contributors.

## Getting Started

These instructions will get you a copy of the project up and running
on your local machine for development and testing purposes. See
deployment for notes on how to deploy the project on a live system.

* git clone https://opensource.ieee.org/example/example.git

> *Alternatively, if your repository uses submodule then provide*
> *instructions along these lines*
> For a repo with submodules, we can pull all submodules using
> 
> git submodule update --init --recursive
> for the first time. All submodules will be pulled down locally.
> 
> To update submodules, we can use
> 
> git submodule update --recursive --remote
> or simply

> git pull --recurse-submodules

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

A step by step series of examples that tell you how to get a
development env running

```
Step through
```

1. Step one
2. Step two
3. Step three, etc

```
until finished
```

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).