-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Create build, channels, contribute documents
- Loading branch information
1 parent
00d4efb
commit 9d7994e
Showing
4 changed files
with
36 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
## Building the repository from source | ||
|
||
**TODO** | ||
|
||
to build all the packages, run `make` from the base repository. this will | ||
involve downloading a docker image (1GB) and the remarkable toolchain which | ||
will expand to 3GB. the final build artifacts will be found in `artifacts/`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Choosing a release channel | ||
|
||
**TODO** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## Contributing to Toltec | ||
|
||
**TODO** | ||
|
||
### Adding a new package | ||
|
||
* clone this repository | ||
* switch to `testing` branch | ||
* edit package/$PACKAGE/package, making sure to bump the version | ||
* build the package (`make $PACKAGE`), making sure everything looks ok in artifacts/package/$PACKAGE/ | ||
* install the package to your tablet, verifying things work as expected | ||
* for new packages, submit a pull request with the title: [$PACKAGE][$VERSION] - New Package | ||
* for updating packages, submit a pull request with the title: [$PACKAGE][$VERSION] - Updated Package |