Git Product home page Git Product logo

os-readme's Introduction

Open Source Readme

Das Ziel dieser Übung ist zu lernen ein Dokument in Markdown zu schreiben.

Dafür werden wir das Readme.md für ein Open-Source Projekt schreiben. Lieber etwas, dass du jetzt oder in die Zukunft gerne entwickeln würdest.

  1. Legt ein neues Repository an.
  2. Schreib das README.md Datei, dass dieses Projekt beschreibt: Projekttitle, Ziele, Worum geht's, Technologien, Schritte,... sowohl wie andere mitmachen dürften. Worum das Projekt geht darfst du selber auswählen.
  3. Wichtig ist, dass dein Readme die folgende Elemente beinhaltet (mindestens ein Mal jedes Element):

Elemente

  • ein heading für das Dokument und bei jedem Section
  • ein paragraph
  • a line break
  • eine horizontal Linie oder Trennungslinie (horizontal rule) um Sections deines Dokumentes zu trennen
  • bold text
  • italic text
  • einen link zu Beispiele, Dokumentation über Technologien die du vorplannst zu nutzen, Artikeln, Profiles...
  • eine Zeile oder ein Block Code vielleicht mit einem kleinen Beispiel, oder einfach einen Gruß
  • eine Liste mit Projektenfeatures und / oder Schritte
  • ein Bild
  • ein mal der Charackter *
  • ein emoticon / emoji

Vorschlage

  • Besuch andere Repositories, um Inspiration sowohl ein genaueres Vorbild zu bekommen, was und wie da zu schreiben.

  • Fügt auch nützliche Links

Ressources

Wenn fertig, teil den Link mit uns! 👋

os-readme's People

Contributors

albertleipzig avatar

Stargazers

Erica de Bem avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.