---
# System prepended metadata

title: README

---

# README

![](https://i.imgur.com/MC9O6zJ.jpg)

### About the lecturer

Joana Chicau is a graphic designer, coder, researcher — with a background in dance. She researches the intersection of the body with the constructed, designed, programmed environment, aiming at widening the ways in which digital sciences is presented and made accessible to the public. 

The latter has been informing a practice and exploration of various forms and formats — interweaving web programming with choreography — from the making of online platforms to performances or workshops. 

In parallel Chicau has been actively participating and organizing events involving multi-location collaborative coding, algorithmic improvisation, discussions on digital equity and activism.

She is currently a lecturer and PhD student at UAL Creative Computing Institute.

* [Link to portfolio website;](https://joanachicau.com/)


##  ▞▞▞ Introduction ▞▞▞ 

⏰ approx. 30min ;

![](https://i.imgur.com/cDJTRFT.png)


### What is a README file?

A [README](https://en.wikipedia.org/wiki/README) file contains information about the other files in a directory or archive of computer software.

The README file is often written using [Markdown](https://en.wikipedia.org/wiki/Markdown) a lightweight markup language for creating formatted text using a plain-text editor.


#### README file growing anatomy:

* Project Name
* Project Logotype
* Table of Contents (for easier navigation)
* Project Description
    * technologies used and how to contribute
    * key features
    * aims, goals, project philosophy notes ("the why another")
* Usage
    * Installation setup
    * Demo (screenshots, gifs, video links)
    * Links for further reading
    * Issues and limitations
* FAQ (most frequently asked questions)
* How to Contribute
* Author and Contributors;
* How to Support
* License
* Credits and Aknowledgements


#### References 

* [Make a README — brief explanation](https://www.makeareadme.com/)
* [Markdown Syntax](https://www.markdownguide.org/basic-syntax)
* [README so — online tool](https://readme.so/)

### Examples

* [P5.JS docs](https://p5js.org/contributor-docs/#/) and  [P5.JS Github](https://github.com/processing/p5.js/tree/main/contributor_docs)
* [README - longer list of examples](https://github.com/matiassingers/awesome-readme#examples)

##  ▞▞▞▞▞▞▞ Exercise 01 ▞▞▞▞▞▞▞ 

⏰ approx. 30min ;

#### Compare and contrast README files ✨ 👀

Write down notes on the anaysis of the READMEs, consider:
* Who is the audience?
* What is the focus of the README?
* How are the READMEs structured?
* How similar or different are they?
* What other links and document complement the README file?



---


*Study Cases:*

 ▖▘▖▘▖▘▖ **group 1**  ▖▘▖▘▖▘▖

▖  Solar Low Tech Magazine
* [About](https://solar.lowtechmagazine.com/about.html)
* [Wiki](https://github.com/lowtechmag/solar/wiki/Solar-Web-Design)
* [README](https://github.com/lowtechmag/solar/blob/master/README.md "title")

▘ Low Impact OB
* [Low Impact Organic Basics manifesto](https://lowimpact.organicbasics.com/gbp#manifesto)
* [README](https://github.com/Organic-Basics/ob-low-impact-website)

▘▖▘▖▘▖▘ **group 2**  ▘▖▘▖▘▖▘

▖ Amelie Dumont 
* [Amelie's Portfolio](https://www.amelie.tools/)
* [README]( https://gitlab.com/ameliedumont/fonts/-/tree/master/Chemins)

▘  Open Source Publishing
* [Begika Font](http://osp.kitchen/foundry/belgica-belgika/)
* [README](https://gitlab.constantvzw.org/osp/foundry.belgica-belgika/-/blob/master/README.md)


 ▖▘▖▘▖▘▖ **group 3**  ▖▘▖▘▖▘▖

▖ Rafael Bastide 
* [Rafael's Portfolio](https://raphaelbastide.com/)
* [Stolon Interface](https://gitlab.com/raphaelbastide/stolon)

▘ Oliva Jack
* [Hydra](https://hydra.ojack.xyz/)
* [README](https://github.com/hydra-synth/hydra)
* [hydra-book](https://hydra-book.glitch.me/#/)

▘▖▘▖▘▖▘ **group 4**  ▘▖▘▖▘▖▘
 
▖ Anti Boredom
* [P5 Riso]( https://antiboredom.github.io/p5.riso/)

▘ Winnie Soon
* [Vocable Code](https://www.siusoon.net/projects/vocablecode)
* [README](https://github.com/siusoon/VocableCode)


 ▖▘▖▘▖▘▖ **group 5**  ▖▘▖▘▖▘▖
 
▖ Ramsey Nasser
* [قلب](https://nas.sr/%D9%82%D9%84%D8%A8/)
* [README](https://github.com/nasser/---)


▘ Karounwi Anoulowapo
* [Coding in Indigenous African Languages](https://esoteric.codes/blog/african-programming-languages)
* [Yorlang Programming Language](https://anoniscoding.github.io/yorlang/)
* [README](https://github.com/anoniscoding/yorlang)





## ▞▞▞▞▞▞▞ Exercise 02 ▞▞▞▞▞▞▞ 

⏰ approx. 30min ;

#### Create Your Own README! * ੈ✩‧₊˚

Gather in groups.
Choose a specific tool to write a README file for.
Consider:
* Who is your audience? Write a small paragraph defining your audience and their needs;
* How can you best communicate everything your tool does? Divide your file into sections;
* What is missing? Swap with another group to hear feedback;

You can use this [online MarkDown editor](https://readme.so/) for this exercise.

At the end, please add your MarkDowns to [this Padlet](https://artslondon.padlet.org/jclarke101/vwcgrqjezjvyejic).

#### Further references 

* [Intersections of Care](https://www.intersectionsofcare.net/guidelines/)
