Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 1.71 KB

README.md

File metadata and controls

55 lines (42 loc) · 1.71 KB
Raw

Equinor Lithology Patterns

The repository is responsible for bundling the SVG lithology patterns. The patterns themselves should be able to be used by any project. Initially only an npm module is published to be consumed by a variety of Javascript projects, however modules for other languages (such as NuGet) will also be placed inside this repo.

The project is licensed under the MIT license following the open source strategy of Equinor.

Contributing

This repository hosts the lithology patterns inside the assets/ folder. If more patterns need to be added, these should be placed inside the figma/ folder and pre-process them by running npm run patterns:process.

NPM

The package.json describes that these raw folders should be bundled within the NPM package whenever the bundle gets published.

The library doesn't define how you need to bundle your application in order to use the SVG's. The SVG's can simply be imported and it's up to the application to decide how to handle the SVG's.

import choosePatternName from 'lithology-patterns/assets/svg/30000.svg

Adding new pattern

  1. Place new pattern in assets/svg
  2. Run npm patterns:process
  3. Commit
  4. Create PR or Push to Main

NuGet

TODO

Others

TODO

Patterns