Coder Social home page Coder Social logo

Rationalise documentation about pyani HOT 2 OPEN

widdowquinn avatar widdowquinn commented on August 11, 2024
Rationalise documentation

from pyani.

Comments (2)

baileythegreen avatar baileythegreen commented on August 11, 2024

The current README has this table of contents:

Table of Contents

@widdowquinn From the conversation the other day, and the outline in the wiki, I think these sections of the README should be reduced/moved elsewhere:


The non-standard installation details could go into the wiki.


This might go into too much detail for the README, especially if it should eventually also detail SLURM stuff.


(This one maybe needs to stay; it depends a bit on the default version of pyani for the repo, I think.)


This section seems like it should either come earlier in the README, or be in the wiki:

from pyani.

peterjc avatar peterjc commented on August 11, 2024

See also the CONTRIBUTING.md convention encouraged by GitHub which would hold or at least point to developer centric information like coding style, CI setup, issue management.

from pyani.

Related Issues (20)

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.