added readme template
This commit is contained in:
weygoldt
parent
056a34ba6b
commit
118fb3dcbe
312
README.md
312
README.md
@ -1,64 +1,248 @@
|
|||||||
# Chirp detection - GP2023
|
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
|
||||||
## Git-Repository and commands
|
<a name="readme-top"></a>
|
||||||
|
<!--
|
||||||
- Go to the [Bendalab Git-Server](https://whale.am28.uni-tuebingen.de/git/) (https://whale.am28.uni-tuebingen.de/git/)
|
*** Thanks for checking out the Best-README-Template. If you have a suggestion
|
||||||
- Create your own account (and tell me ;D)
|
*** that would make this better, please fork the repo and create a pull request
|
||||||
* I'll invite you the repository
|
*** or simply open an issue with the tag "enhancement".
|
||||||
- Clone the repository
|
*** Don't forget to give the project a star!
|
||||||
-
|
*** Thanks again! Now go create something AMAZING! :D
|
||||||
```sh
|
-->
|
||||||
git clone https://whale.am28.uni-tuebingen.de/git/raab/GP2023_chirp_detection.git
|
|
||||||
```
|
|
||||||
|
|
||||||
## Basic git commands
|
<!-- PROJECT SHIELDS -->
|
||||||
|
<!--
|
||||||
- pull changes in git
|
*** I'm using markdown "reference style" links for readability.
|
||||||
```shell
|
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
||||||
git pull origin <branch>
|
*** See the bottom of this document for the declaration of the reference variables
|
||||||
```
|
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
||||||
- commit chances
|
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
||||||
```shell
|
-->
|
||||||
git commit -m '<explaination>' file # commit one file
|
<!-- [![Contributors][contributors-shield]][contributors-url] -->
|
||||||
git commit -a -m '<explaination>' # commit all files
|
<!-- [![Forks][forks-shield]][forks-url] -->
|
||||||
```
|
<!-- [![Stargazers][stars-shield]][stars-url] -->
|
||||||
- push commits
|
<!-- [![Issues][issues-shield]][issues-url] -->
|
||||||
```shell
|
<!-- [![MIT License][license-shield]][license-url] -->
|
||||||
git push origin <branch>
|
<!-- [![LinkedIn][linkedin-shield]][linkedin-url] -->
|
||||||
```
|
|
||||||
|
|
||||||
## Branches
|
|
||||||
Use branches to work on specific topics (e.g. 'algorithm', 'analysis', 'writing', ore even more specific ones) and merge
|
<!-- PROJECT LOGO -->
|
||||||
them into Master-Branch when it works are up to your expectations.
|
<br />
|
||||||
|
<div align="center">
|
||||||
The "master" branch should always contain a working/correct version of your project.
|
<a href="https://github.com/github_username/repo_name">
|
||||||
|
<img src="assets/logo.svg" alt="Logo" width="150" height="100">
|
||||||
- Create/change into branches
|
</a>
|
||||||
```shell
|
|
||||||
# list all branches (highlight active branch)
|
<h3 align="center">chirpdetector</h3>
|
||||||
git banch -a
|
|
||||||
# switch into existing
|
<p align="center">
|
||||||
git checkout <existing branch>
|
An algorithm to detect the chirps of weakly electric fish.
|
||||||
# switch into new branch
|
<br />
|
||||||
git checkout master
|
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
|
||||||
git checkout -b <new branch>
|
<br />
|
||||||
```
|
<br />
|
||||||
|
<a href="https://github.com/github_username/repo_name">View Demo</a>
|
||||||
|
·
|
||||||
- Re-merging with master branch
|
<a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
|
||||||
1) get current version of master and implement it into branch
|
·
|
||||||
```shell
|
<a href="https://github.com/github_username/repo_name/issues">Request Feature</a>
|
||||||
git checkout master
|
</p>
|
||||||
git pull origin master
|
</div>
|
||||||
git checkout <branch>
|
|
||||||
git rebase master
|
|
||||||
```
|
|
||||||
This resets you branch to the fork-point, executes all commits of the current master before adding the commits of you
|
<!-- TABLE OF CONTENTS -->
|
||||||
branch. You may have to resolve potential conflicts. Afterwards commit the corrected version and push it to your branch.
|
<details>
|
||||||
|
<summary>Table of Contents</summary>
|
||||||
2) Update master branch master
|
<ol>
|
||||||
- correct way: Create
|
<li>
|
||||||
```shell
|
<a href="#about-the-project">About The Project</a>
|
||||||
git checkout master
|
<ul>
|
||||||
git merge <branch>
|
<li><a href="#built-with">Built With</a></li>
|
||||||
git push origin master
|
</ul>
|
||||||
```
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="#getting-started">Getting Started</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
||||||
|
<li><a href="#installation">Installation</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a href="#usage">Usage</a></li>
|
||||||
|
<li><a href="#roadmap">Roadmap</a></li>
|
||||||
|
<li><a href="#contributing">Contributing</a></li>
|
||||||
|
<li><a href="#license">License</a></li>
|
||||||
|
<li><a href="#contact">Contact</a></li>
|
||||||
|
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
||||||
|
</ol>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ABOUT THE PROJECT -->
|
||||||
|
## About The Project
|
||||||
|
|
||||||
|
[![Product Name Screen Shot][product-screenshot]](https://example.com)
|
||||||
|
|
||||||
|
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ### Built With -->
|
||||||
|
|
||||||
|
<!-- * [![Next][Next.js]][Next-url] -->
|
||||||
|
<!-- * [![React][React.js]][React-url] -->
|
||||||
|
<!-- * [![Vue][Vue.js]][Vue-url] -->
|
||||||
|
<!-- * [![Angular][Angular.io]][Angular-url] -->
|
||||||
|
<!-- * [![Svelte][Svelte.dev]][Svelte-url] -->
|
||||||
|
<!-- * [![Laravel][Laravel.com]][Laravel-url] -->
|
||||||
|
<!-- * [![Bootstrap][Bootstrap.com]][Bootstrap-url] -->
|
||||||
|
<!-- * [![JQuery][JQuery.com]][JQuery-url] -->
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- GETTING STARTED -->
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
This is an example of how you may give instructions on setting up your project locally.
|
||||||
|
To get a local copy up and running follow these simple example steps.
|
||||||
|
|
||||||
|
<!-- ### Prerequisites -->
|
||||||
|
|
||||||
|
<!-- This is an example of how to list things you need to use the software and how to install them. -->
|
||||||
|
<!-- * npm -->
|
||||||
|
<!-- ```sh -->
|
||||||
|
<!-- npm install npm@latest -g -->
|
||||||
|
<!-- ``` -->
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
1. Get a free API Key at [https://example.com](https://example.com)
|
||||||
|
2. Clone the repo
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/github_username/repo_name.git
|
||||||
|
```
|
||||||
|
3. Install NPM packages
|
||||||
|
```sh
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
4. Enter your API in `config.js`
|
||||||
|
```js
|
||||||
|
const API_KEY = 'ENTER YOUR API';
|
||||||
|
```
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- USAGE EXAMPLES -->
|
||||||
|
## 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](https://example.com)_
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ROADMAP -->
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
- [ ] Feature 1
|
||||||
|
- [ ] Feature 2
|
||||||
|
- [ ] Feature 3
|
||||||
|
- [ ] Nested Feature
|
||||||
|
|
||||||
|
See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- <!-1- CONTRIBUTING -1-> -->
|
||||||
|
<!-- ## Contributing -->
|
||||||
|
|
||||||
|
<!-- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. -->
|
||||||
|
|
||||||
|
<!-- If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". -->
|
||||||
|
<!-- Don't forget to give the project a star! Thanks again! -->
|
||||||
|
|
||||||
|
<!-- 1. Fork the Project -->
|
||||||
|
<!-- 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -->
|
||||||
|
<!-- 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -->
|
||||||
|
<!-- 4. Push to the Branch (`git push origin feature/AmazingFeature`) -->
|
||||||
|
<!-- 5. Open a Pull Request -->
|
||||||
|
|
||||||
|
<!-- <p align="right">(<a href="#readme-top">back to top</a>)</p> -->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- <!-1- LICENSE -1-> -->
|
||||||
|
<!-- ## License -->
|
||||||
|
|
||||||
|
<!-- Distributed under the MIT License. See `LICENSE.txt` for more information. -->
|
||||||
|
|
||||||
|
<!-- <p align="right">(<a href="#readme-top">back to top</a>)</p> -->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- CONTACT -->
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
|
||||||
|
|
||||||
|
Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ACKNOWLEDGMENTS -->
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
* []()
|
||||||
|
* []()
|
||||||
|
* []()
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- MARKDOWN LINKS & IMAGES -->
|
||||||
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||||||
|
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
|
||||||
|
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
|
||||||
|
[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
|
||||||
|
[forks-url]: https://github.com/github_username/repo_name/network/members
|
||||||
|
[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
|
||||||
|
[stars-url]: https://github.com/github_username/repo_name/stargazers
|
||||||
|
[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
|
||||||
|
[issues-url]: https://github.com/github_username/repo_name/issues
|
||||||
|
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
|
||||||
|
[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt
|
||||||
|
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
||||||
|
[linkedin-url]: https://linkedin.com/in/linkedin_username
|
||||||
|
[product-screenshot]: images/screenshot.png
|
||||||
|
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
|
||||||
|
[Next-url]: https://nextjs.org/
|
||||||
|
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
|
||||||
|
[React-url]: https://reactjs.org/
|
||||||
|
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
|
||||||
|
[Vue-url]: https://vuejs.org/
|
||||||
|
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
|
||||||
|
[Angular-url]: https://angular.io/
|
||||||
|
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
|
||||||
|
[Svelte-url]: https://svelte.dev/
|
||||||
|
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
|
||||||
|
[Laravel-url]: https://laravel.com
|
||||||
|
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
|
||||||
|
[Bootstrap-url]: https://getbootstrap.com
|
||||||
|
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
|
||||||
|
[JQuery-url]: https://jquery.com
|
||||||
|
|
||||||
|
|||||||
64
README1.md
Normal file
64
README1.md
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
# Chirp detection - GP2023
|
||||||
|
## Git-Repository and commands
|
||||||
|
|
||||||
|
- Go to the [Bendalab Git-Server](https://whale.am28.uni-tuebingen.de/git/) (https://whale.am28.uni-tuebingen.de/git/)
|
||||||
|
- Create your own account (and tell me ;D)
|
||||||
|
* I'll invite you the repository
|
||||||
|
- Clone the repository
|
||||||
|
-
|
||||||
|
```sh
|
||||||
|
git clone https://whale.am28.uni-tuebingen.de/git/raab/GP2023_chirp_detection.git
|
||||||
|
```
|
||||||
|
|
||||||
|
## Basic git commands
|
||||||
|
|
||||||
|
- pull changes in git
|
||||||
|
```shell
|
||||||
|
git pull origin <branch>
|
||||||
|
```
|
||||||
|
- commit chances
|
||||||
|
```shell
|
||||||
|
git commit -m '<explaination>' file # commit one file
|
||||||
|
git commit -a -m '<explaination>' # commit all files
|
||||||
|
```
|
||||||
|
- push commits
|
||||||
|
```shell
|
||||||
|
git push origin <branch>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Branches
|
||||||
|
Use branches to work on specific topics (e.g. 'algorithm', 'analysis', 'writing', ore even more specific ones) and merge
|
||||||
|
them into Master-Branch when it works are up to your expectations.
|
||||||
|
|
||||||
|
The "master" branch should always contain a working/correct version of your project.
|
||||||
|
|
||||||
|
- Create/change into branches
|
||||||
|
```shell
|
||||||
|
# list all branches (highlight active branch)
|
||||||
|
git banch -a
|
||||||
|
# switch into existing
|
||||||
|
git checkout <existing branch>
|
||||||
|
# switch into new branch
|
||||||
|
git checkout master
|
||||||
|
git checkout -b <new branch>
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
- Re-merging with master branch
|
||||||
|
1) get current version of master and implement it into branch
|
||||||
|
```shell
|
||||||
|
git checkout master
|
||||||
|
git pull origin master
|
||||||
|
git checkout <branch>
|
||||||
|
git rebase master
|
||||||
|
```
|
||||||
|
This resets you branch to the fork-point, executes all commits of the current master before adding the commits of you
|
||||||
|
branch. You may have to resolve potential conflicts. Afterwards commit the corrected version and push it to your branch.
|
||||||
|
|
||||||
|
2) Update master branch master
|
||||||
|
- correct way: Create
|
||||||
|
```shell
|
||||||
|
git checkout master
|
||||||
|
git merge <branch>
|
||||||
|
git push origin master
|
||||||
|
```
|
||||||
1184
assets/logo.svg
Normal file
1184
assets/logo.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 84 KiB |
1184
poster/figs/logo.svg
Normal file
1184
poster/figs/logo.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 84 KiB |
Loading…
Reference in New Issue
Block a user