Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Update Makefile, and README.md #64

Merged
merged 1 commit into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,24 +1,5 @@
check:
golangci-lint run

check-clean-cache:
golangci-lint cache clean

protoc-setup:
wget -P meshes https://raw.githubusercontent.com/layer5io/meshery/master/meshes/meshops.proto

proto:
protoc -I meshes/ meshes/meshops.proto --go_out=plugins=grpc:./meshes/





site:
$(jekyll) serve --drafts --livereload

build:
$(jekyll) build --drafts
yarn run build-all

docker:
docker run --name site -d --rm -p 4000:4000 -v `pwd`:"/srv/jekyll" jekyll/jekyll:4.0.0 bash -c "bundle install; jekyll serve --drafts --livereload"
format:
yarn run format
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,21 @@ The Sistent Design System from Layer5 provides the open source building blocks t
### Packages

- Design System components in React.js
- npm package: `@layer5/sistent-components`
- npm package:

`@layer5/sistent-components`
`@layer5/sistent-svg`

### Brand

- Layer5 Brand Guide ([PDF](https://layer5.io/brand/brand-guide.pdf))
- [Layer5 Logos](https://layer5.io/company/brand) (more assets available in shared Community drive).

### How to get started

1. Install `[email protected]`
2. Use `yarn` to install dependencies

<div>&nbsp;</div>

## Join the Layer5 community!
Expand Down