diff --git a/README.md b/README.md index 8de86c54..b55c73fe 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,36 @@ # About gist -gist is Semantic Arts' minimalist upper ontology for the enterprise. It is designed to have the maximum coverage of typical business ontology concepts with the fewest number of primitives and the least amount of ambiguity. +gist is Semantic Arts' minimalist upper ontology for the enterprise. It is designed to provide the maximum coverage of typical business ontology concepts with the fewest number of primitives and the least amount of ambiguity. The gist ontology defines around 100 classes and about the same number of attributes and relationships and serves as a foundation for building more specialized ontologies. -We maintain an active gist community forum where developers and users of gist come together to discuss the gist model, implementation best practices, and the evolution of gist. Meetings occur virtually on the first Thursday of every other month, starting in January. Please send email to [GistForum@semanticarts.com](mailto:GistForum@semanticarts.com) if you would like to become involved. - -You can also contribute to gist by adding your comments to [issue discussion threads](https://github.com/semanticarts/gist/issues) and submitting new issues and pull requests (see [guidelines for contributions](https://github.com/semanticarts/gist/blob/master/docs/Contributing.md)). You can view [minutes](https://github.com/semanticarts/gist/wiki/gist-Development-Team-Meeting-Notes) from our bi-monthly review sessions to find out what we've been discussing and get a preview of upcoming changes to gist. +gist represents the fundamental concepts and relationships that exist across most business use cases and is designed to be domain-independent. This flexibility allows gist to be applied to a wide spectrum of domains and facilitates both interoperability and knowledge integration. We have designed gist for clarity and completeness to cover nearly all the concepts that exist in real-world ontology development. -gist is free and open to the public under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license. In addition to the conditions of this license, we require that any concepts used from gist remain in the gist namespace, and that you do not define your own term definitions in the gist namespace. +gist is free and open to the public under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license. You can use it as you see fit for any purpose, as long as you give us attribution. In addition to the conditions of this license, we require that any terms used from gist remain in the gist namespace, and that you do not define your own terms in the gist namespace. To get gist: -- Download the [latest released version of gist](https://downloads.semanticarts.com/gistCore_Current_Version.zip) or from the zip file available on the [GitHub repository releases page](https://github.com/semanticarts/gist/releases). +- Download the [latest released version of gist](https://downloads.semanticarts.com/gistCore_Current_Version.zip) or the zip file available on the [GitHub repository releases page](https://github.com/semanticarts/gist/releases). - Import into Protégé with the link: . - Clone or download gist from the [GitHub repository](https://github.com/semanticarts/gist/). For more information on gist and to download previous versions, see the [Semantic Arts website](https://www.semanticarts.com/gist). +## gist Community + +We maintain an active gist community forum where developers and users of gist come together to discuss the gist model, implementation best practices, and the evolution of gist. Meetings occur virtually on the first Thursday of every other month, starting in January. Please send email to [GistForum@semanticarts.com](mailto:GistForum@semanticarts.com) if you would like to become involved. + +You can also contribute to gist by adding your comments to [issue discussion threads](https://github.com/semanticarts/gist/issues) and submitting new issues and pull requests (see [guidelines for contributions](https://github.com/semanticarts/gist/blob/master/docs/Contributing.md)). You can view [minutes](https://github.com/semanticarts/gist/wiki/gist-Development-Team-Meeting-Notes) from our bi-monthly review sessions to find out what we've been discussing and get a preview of upcoming changes to gist. + +## Design Features + +Significant design features of gist include: + +gist defines a small number of top-level concepts on which everything else is based, both in gist itself and in enterprise or application ontologies that use gist as a foundation. These concepts are not philosophical abstractions with unfamiliar terms such as endurant, perdurant, or qualia; they are everyday concepts with ordinary names such as person, organization, and agreement, whose meanings are just what you would expect. These high-level concepts provide building blocks for defining more specific domain concepts in a gist-based ontology. + +gist has extensive and fine-grained disjointness at the highest level in order to help you avoid making certain types of logical errors in your ontologies or data that are based on gist. Because we explicity state, for example, that governmental organizations (such as the US federal government) can’t be intergovernmental organizations (such as the UN), a reasoner will complain of logical inconsistency if something has been typed as both. Without disjointness, such inconsistencies will not be surfaced. + +gist uses domain and range specifications sparingly in order to make properties more broadly applicable. To eliminate redundancy and reduce cognitive load, inverse properties are not defined. Subclasses are typically defined using a pattern that specifies how they specialize the superclass. + ## Setting up a Local gist Repository - Clone the [gist GitHub repository](https://github.com/semanticarts/gist.git). @@ -31,6 +45,14 @@ For more information on gist and to download previous versions, see the [Semanti We provide a number of resources for learning more about gist. +### The Periodic Table of gist + +The Periodic Table of gist is a graphical representation of gist coverage organized into abstract conceptual clusters. + +[![gist periodic table](gist-periodic-table-thumb.png)](gist-periodic-table.png) + +(click image to enlarge) + ### The gist-doc Repository Extensive documentation of gist is available in the [gist-doc repository](https://github.com/semanticarts/gist-doc). This repository contains documentation of the [Semantic Arts gist minimalist upper ontology](https://github.com/semanticarts/gist/tree/master) in three formats: narrative, graphical, and Widoco-style. diff --git a/bundle.yaml b/bundle.yaml index 72914656..f0358403 100644 --- a/bundle.yaml +++ b/bundle.yaml @@ -200,12 +200,14 @@ actions: - "MajorVersionMigration.md" - "Namespace.md" - action: "copy" - message: "Copying readme and gist logo to docs directory." + message: "Copying readme, gist logo, and periodic table images to docs directory." source: "{input}" target: "{output}/docs/" includes: - "README.md" - "gist-logo.png" + - "gist-periodic-table.png" + - "gist-periodic-table-thumb.png" - action: "markdown" message: "Formatting documentation as HTML." source: "{output}/docs/" diff --git a/docs/release_notes/1349-add-website-text-to-readme.md b/docs/release_notes/1349-add-website-text-to-readme.md new file mode 100644 index 00000000..f29f4310 --- /dev/null +++ b/docs/release_notes/1349-add-website-text-to-readme.md @@ -0,0 +1,3 @@ +### Patch + +- Expanded `README.md` to provide additional information about gist and its design features. Issue [#1349](https://github.com/semanticarts/gist/issues/1349). diff --git a/gist-periodic-table-thumb.png b/gist-periodic-table-thumb.png new file mode 100644 index 00000000..dc18653b Binary files /dev/null and b/gist-periodic-table-thumb.png differ diff --git a/gist-periodic-table.png b/gist-periodic-table.png new file mode 100644 index 00000000..9d7f60ad Binary files /dev/null and b/gist-periodic-table.png differ