A README template to jumpstart your projects!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
In this section you should describe your project, including any datasets you used and appropriate citations. You may refer to your project report or cite your paper for more detailed information.
Here goes the title with hyperlink
You can include tables or images to summarize your results when and if appropriate.
In this section you should provide instructions on how to use this repository to recreate your project locally.
Here, list all libraries, packages and other dependencies that need to be installed to run your project. Include library versions and how they should be installed if a special requirement is needed.
For example, this is how you would list them:
- Transformers 4.8.0
conda install -c conda-forge transformers
- OpenCV 4.5.2
conda install -c conda-forge opencv
Alternatively, you can export your Python working environment, push it to your project's repository and allow users to clone it locally. This way, anyone can install it and they will have all dependencies needed. Here is how you export a copy of your Python environment:
conda env export > requirements.ymlThe user will be able to recreate it using:
conda env create -f requirements.yml- Clone the repo
git clone https://github.com/catiaspsilva/README-template.git
- Setup (and activate) your environment
conda env create -f requirements.ymlUse this space to show useful examples of how a project can be used. For course projects, include which file to execute and the format of any input variables.
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
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Your Name - @your_twitter - [email protected]
Project Link: https://github.com/your_username/repo_name
You can acknowledge any individual, group, institution or service.