Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
Orekit
Orekit
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 54
    • Issues 54
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 5
    • Merge Requests 5
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Orekit
  • OrekitOrekit
  • Issues
  • #541

Closed
Open
Opened Apr 30, 2019 by Sébastien Dinot@sdinotOwner

README enhancement

In my humble opinion, the README file provided with Orekit source code is totally old-fashioned:

  • It uses the plain text format rather than a lightweight markup language such as Markdown or reStructuredText.
  • It is poor in information (no indication is provided, for example, on how to contribute, or how to report a bug).

Several initiatives have attempted to list good practices regarding the content of a README file and/or to provide README templates:

  • Readme Best Practices
  • Art of README

I think that Orekit merits such modern README file.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
10.0
Milestone
10.0
Assign milestone
Time tracking
None
Due date
None
Reference: orekit/orekit#541