Best-README-Template

Read me template!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents example

• About the Project
  • Built With
• Getting Started
  • Prerequisites
• How to's
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About the Project

A brief description of the project, explain about what the project does etc

If there is bullet points:

• example of a bullet point

Built With

Any frameworks which is used in the project.

can use the follwowing template for a link if needed

• python

Getting Started

Setting ups instructions, may be you need to install python from the IT service portal etc

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

How to's

1. Configure the git for the first time

git config --global user.name "your name"
git config --global user.email "[email protected]"

2. If you want to simply clone this empty repository then run this command in your terminal.

git clone ssh://[email protected]:7999/fc072_euv/generic.git

3. My code is ready to be pushed If you already have code ready to be pushed to this repository then run this in your terminal.

cd existing-project
git init
git add --all
git commit -m "Initial Commit"
git remote add origin ssh://[email protected]:7999/fc072_euv/generic.git
git push -u origin master

4. My code is already tracked by Git If your code is already tracked by Git then set this repository as your "origin" to push to.

cd existing-project
git remote set-url origin ssh://[email protected]:7999/fc072_euv/generic.git
git push -u origin --all
git push origin --tags

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the [open issues](See the open issues for a list of proposed features (and known issues).

Contributing

please do contribute.

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

License

Distributed under the License Name. See LICENSE for more information.

Contact

Your Name - @example - @asml.com Project Link: https://github.com/your_username/repo_name

Acknowledgements

• ASML