Sitelet https://github.com/open-rpc/client-js/commit/988ae60
Skip to content

Commit 988ae60

Browse files
shanejonasshanejonas
committed
fix: move to pristine
1 parent bd53361 commit 988ae60

4 files changed

Lines changed: 29 additions & 12 deletions

File tree

‎BUILDING.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Jade Project Building
1+
# Project Building
22

33
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
44

@@ -8,7 +8,7 @@ When using the name 'version' we mean the versioning scheme described in [VERSIO
88

99
## Introduction
1010

11-
This document is to describe the functionality a jade project MUST provide in terms of creating build artifacts. It also describes the structure in which jade project's MUST write build artifacts in.
11+
This document is to describe the functionality a project MUST provide in terms of creating build artifacts. It also describes the structure in which project's MUST write build artifacts in.
1212

1313
We propose:
1414
- a folder name convention for build artifacts
@@ -43,7 +43,7 @@ Below is an example:
4343
.
4444
└── build
4545
└── windows
46-
└── jade-signer.{ext}
46+
└── my-build.exe
4747
```
4848

4949
## Build Platform Targets
@@ -58,7 +58,7 @@ The result of this is that every project MUST produce a build for each target pl
5858
- `docker-compose up -f ./docker-compose.build.yml`
5959

6060
The docker-compose.build.yml file MUST be placed in the project's root directory.
61-
Any dockerfiles used by the docker-compose may be placed at the discretion of the developer of the jade project.
61+
Any dockerfiles used by the docker-compose may be placed at the discretion of the developer of the project.
6262

6363
## Build Pipeline
6464
Starting from clean master branch with latest HEAD

‎README.md‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,21 @@
1-
# jade
1+
# Pristine
22

3-
![](https://www.etclabs.org/dist/resources/images/v2/logo-top.png)
4-
Supported by [ETC Labs](https://www.etclabs.org/)
3+
Pristine is an open source repository in its original condition. It is meant to be a starting point and a place to find resources to augment your own open source repositories.
4+
5+
### Conventions and Specifications
6+
7+
Using conventions and specifications make it easier to:
8+
- build and use composable tools
9+
- ease onboarding
10+
- promote issue and feature discussion
11+
12+
### How to Contribute
13+
14+
How to create tickets and contribute outlined in [CONTRIBUTING.md](CONTRIBUTING.md)
15+
16+
### Docker:
17+
18+
Docker is used as a building block. Here are the resources you need to get started and install docker:
19+
20+
- [Install Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/)
21+
- [Install Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/)

‎RELEASING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Jade Project Releasing
1+
# Project Releasing
22

33
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
44

@@ -14,7 +14,7 @@ We propose:
1414
- a set of release targets that are allowable
1515
- a pipeline for handling the release folder's artifacts
1616

17-
It is NOT the purpose of this document to describe how a project might create a build, NOR is it describing a strcture in which jade projects MUST write build artifacts to. It is describing the structure of the releases themselves, however.
17+
It is NOT the purpose of this document to describe how a project might create a build, NOR is it describing a strcture in which projects MUST write build artifacts to. It is describing the structure of the releases themselves, however.
1818

1919
## Release Targets
2020
1. github

‎VERSIONING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Jade Project Versioning
1+
# Versioning
22

33
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
44

55
This document is licensed under [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
66

77
## Introduction
8-
This document is to describe how a jade project is to version its releases
8+
This document is to describe how a project is to version its releases
99

1010
It also describes standardized tooling around manipulating the version
1111

1212
## Semver
13-
A Jade project MUST use Semantic Versioning [semver](https://semver.org). Build metadata MAY NOT be used in a jade project. Build metadata SHOULD be ignored.
13+
A project MUST use Semantic Versioning [semver](https://semver.org). Build metadata MAY NOT be used in a project. Build metadata SHOULD be ignored.
1414

1515
A Basic summary of Semantic Versioning taken from: [semver.org(https://semver.org)
1616

0 commit comments

Comments
 (0)