search

ONSAS / ONSAS.jl

An Open Nonlinear Structural Analysis Solver in Julia
MIT License
7 stars 1 forks source link

Update README.md #505

Closed mforets closed 2 weeks ago

mforets commented 1 month ago

(i dont understand what does "experimental" communicate)

mforets commented 1 month ago

... If the original idea was to warn potential industrial or academic use cases that this software is still at an early stage of development, it can be said more explicitly (although the < 1.x version somehow communicates that). Eg. like so:

This software is currently under development and may contain bugs or incomplete features. It is intended for testing and educational purposes only. Do not use this software for any critical applications or in the design and construction of actual buildings. The developers assume no responsibility for any consequences resulting from the use of this software in real-world applications.

mvanzulli commented 1 month ago

The original idea was to add a disclaimer that this is not the actual main package planned in the roadmap of ONSAS to migrate all the features of ONSAS.m and development for professional applications. Given that, I'm not against removing adding the following sentence into the REAMDE.md: 

This software is currently under development and may contain bugs or incomplete features. It is intended for testing and educational purposes only.

and remove the (experimental) from the name.

jorgepz commented 1 month ago

Hi! As Mauricio says the idea was to add an explicit disclaimer. Although this could be clear in the version for software experts, an explicit disclaimer is needed to lower expectations and preparing users for not-fully-developed features.

I agree with Mauricio's text proposal.

mforets commented 2 weeks ago

i made some edits, shall we merge now?

mvanzulli commented 2 weeks ago

i made some edits, shall we merge now?

Yes, thanks for the changes 👌🏼