search

BHoM / admin

Repository for raising central issues and questions; Regarding governance, process and multi-repo and framework compliance
GNU Lesser General Public License v3.0
0 stars 0 forks source link

Updated READMEs across repos #4

Closed al-fisher closed 3 years ago

al-fisher commented 4 years ago

As discussed need to create a new series of standard templates based on the types of Toolkits. README's need a review and update anyway and standardising will make sure we capture important info on all (where needed), point to refreshed wiki, but also with some repo specific info were needed.

An extra benefit of implementing a standard format, with known markdown headers means we can scrape some info into upcoming API, much like our changelog is from PRs, if desired.

Can have different readme templates for different types of toolkits:

Capturing iterations with @FraserGreenroyd el al. propose standardising the following sections - using Robot_Toolkit as an example below.

License: LGPL v3 Build status Build Status

Robot_Toolkit

Description of the toolkit and any useful information or example usage. Something like : this toolkit allows interoperability between the BHoM and Autodesk Robot Structural Analysis. Enables creation, manipulation and reading of structural finite element analysis models and analysis results. Etc. ...

https://www.autodesk.co.uk/products/robot-structural-analysis

Known Versions of Software Supported

Autodesk Robot Structural Analysis Professional 2018 Autodesk Robot Structural Analysis Professional 2019

Documentation

For more information about functionality see (links to Toolkit specific Wiki and/or API when ready)

This toolkit is part of the Buildings and Habitats object Model. Find out more on our wiki or at https://bhom.xyz

Quick Start 🚀

Grab the latest installer and a selection of sample scripts.

Getting Started for Developers 🤖

If you want to build the BHoM and the Toolkits from source, it's hopefully easy! 😄 Do take a look at our specific wiki pages here: Getting Started for Developers

Want to Contribute?

BHoM is an open-source project and would be nothing without its community. Take a look at our contributing guidelines and tips here.

Licence

BHoM is free software licenced under GNU Lesser General Public Licence - https://www.gnu.org/licenses/lgpl-3.0.html
Each contributor holds copyright over their respective contributions. The project versioning (Git) records all such contribution source information. See LICENSE and COPYRIGHT_HEADER.

al-fisher commented 4 years ago

Have completed updates to the following repos:

al-fisher commented 4 years ago

@FraserGreenroyd @IsakNaslundBh @pawelbaran @alelom as discussed - added a list to pick a few to tick off next sprint. Based on template above

pawelbaran commented 4 years ago

@al-fisher I am almost there with Revit_Toolkit, however cannot find out how to find project number of Revit_Toolkit in this line: https://ci.appveyor.com/api/projects/status/11a3ucotxcl9746k/branch/master?svg=true (I guess 11a3ucotxcl9746k is specific to Robot_Toolkit and should be replaced with Revit_Toolkit?)

Build status

al-fisher commented 4 years ago

Ah - thanks @pawelbaran - let me look at this now 😄

FraserGreenroyd commented 4 years ago

I will raise some issues for the outstanding toolkits this morning. This checklist is to help me get the correct AppVeyor badges as appropriate.

Have completed updates to the following repos:

FraserGreenroyd commented 4 years ago

All issues raised with suitable AppVeyor badges assigned for people to begin filling in/closing out.

FraserGreenroyd commented 4 years ago

FYI: @adecler @IsakNaslundBh and anyone else assigned an issue, be aware I have provided only the AppVeyor badges which are not easily accessible, but the Azure ones are publicly available so hopefully everyone can get the correct badges ok :smile:

FraserGreenroyd commented 3 years ago

@al-fisher can we update the status of this issue with help from others as appropriate? Would be good to finally close this out as completed, as I suspect most are now done if not ticked off? :smile:

al-fisher commented 3 years ago

Happy to close - with Excel_Toolkit the remaining repo (and issue already raised and bumped)

Thanks @FraserGreenroyd