search

strusoft / femdesign-api

FEM-Design API
https://femdesign-api-docs.onstrusoft.com/
Apache License 2.0
41 stars 20 forks source link

Rename to SDK? #548

Open xRadne opened 2 years ago

xRadne commented 2 years ago

Should this repo and all references to it be called SDK? (Instead of API)

SDK wikipedia:

A software development kit (SDK) is a collection of software development tools in one installable package. They facilitate the creation of applications by having a compiler, debugger and sometimes a software framework. They are normally specific to a hardware platform and operating system combination.[1][2][3] To create applications with advanced functionalities such as advertisements,[4] push notifications,[5] etc; most application software developers use specific software development kits.[6]

API wikipedia:

An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software.[1] A document or standard that describes how to build or use such a connection or interface is called an API specification. A computer system that meets this standard is said to implement or expose an API. The term API may refer either to the specification or to the implementation.

xRadne commented 2 years ago

I think there are 2 main reasons to do this. I think the pros are better than the cons.

Pros:

  1. It's more correct.
  2. Differentiates from the FEM-Design API (struxml/fdscript etc.)

Cons:

  1. Renaming things might cause more confusion rather than reducing (the already low) confusion.
  2. Users don't care about the name. And they don't care were the line goes between the actual API specification and the SDK implementation.
andosca commented 2 years ago

I agree with you. However, we will not change this at this moment. Later... :)