mime
README
Template repo for creating a new Athena component. Scaffolds the Crystal shard's structure as well as define CI etc.
NOTE: This repo assumes the component will be in the athena-framework
org. If it is to be used outside of the org, be sure to update URLs accordingly.
-
Find/replace
COMPONENT_NAME
with the name of the component. This is used as the shard's name. E.x.logger
. 1.1 Be sure to rename the file in./src
, and./spec
as well. -
Replace
NAMESPACE_NAME
with the name of the component's namespace. Documentation for this component will be grouped under this. E.x.Logger
. -
Find/replace
CREATOR_NAME
with your Github display name. E.x.George Dietrich
. -
Find/replace
CREATOR_USERNAME
with your Github username. E.x.blacksmoke16
. -
Find/replace
CREATOR_EMAIL
with your desired email5.1 Can remove this if you don't wish to expose an email.
-
Find/replace
ALIAS_NAME
with the three letter alias for this component; A + 2 letter shortcut toNAMESPACE_NAME
. E.x.ALG
. -
Find/replace
DESCRIPTION
with a short description of what the component does.
Delete from here up
NAMESPACE_NAME
DESCRIPTION.
Getting Started
Checkout the Documentation.
Contributing
Read the general Contributing Guide for information on how to get started.
mime
- 0
- 0
- 0
- 0
- 0
- 2 months ago
- October 19, 2024
MIT License
Thu, 26 Dec 2024 07:15:40 GMT